Get connectors list and status

API Endpoint: Get Connectors

Method: GET
Endpoint: https://{{base_url}}/zsa/api/v2/connectors

This endpoint retrieves a list of connectors available in the system. Upon successful execution, it returns a JSON array containing details about each connector.

Request Parameters

This endpoint does not require any request parameters.

Response Format

The response will be a JSON array with the following structure:

tags: An array of tags associated with the connector (array of strings).
id: The unique identifier for the connector (string).
createdAt: The timestamp indicating when the connector was created (string).
label: A human-readable label for the connector (string).
state: The current state of the connector (string).
activated: A boolean indicating whether the connector is activated (boolean).
host: The host address for the connector (string).
port: The port number used by the connector (integer).
type: The type of the connector (string).
information: An array of objects containing additional information about the connector, with each object having:
- name: The name of the information (string).
- value: The value of the information (string).
- type: The type of the information (string).
- label: A label for the information (string).
- description: A description of the information (string).
- unit: The unit of measurement for the information (string).
properties: An array of objects detailing the properties of the connector, with each object containing:
- name: The name of the property (string).
- value: The current value of the property (string).
- defaultValue: The default value of the property (string).
- type: The type of the property (string).
- complexity: The complexity level of the property (string).
- label: A label for the property (string).
- description: A description of the property (string).
- unit: The unit of measurement for the property (nullable string).

Example Response

[
    {
        "tags": [],
        "id": "",
        "createdAt": "",
        "label": "",
        "state": "",
        "activated": true,
        "host": "",
        "port": 0,
        "type": "",
        "information": [
            {
                "name": "",
                "value": "",
                "type": "",
                "label": "",
                "description": "",
                "unit": ""
            }
        ],
        "properties": [
            {
                "name": "",
                "value": "",
                "defaultValue": "",
                "type": "",
                "complexity": "",
                "label": "",
                "description": "",
                "unit": null
            }
        ]
    }
]