Requirements
An active Farsight® admin account
Authorized API key
Limitations
GET Connections (GET /v1/connections)
Since you are retrieving all the connections available in your organization, all you need is to authorize the API call, and the response will contain the list of all available connections. All request parameters are optional unless otherwise noted:
Input Parameter | Type | Required | Definition |
SiteId | integer | Yes | The ID of the site. |
Limit | integer | No | The number of items to return. Ranges from 1 to 50 (Free tier) or 1 to 500 (pro). Default value is 25. |
Offset | string | No | The index of the first item to return. Must be 0 or greater. It is set to 0 by default. |
sort | string | No | Fields used in the results sorting. Composed by the name of the field followed by :asc or :desc. Example: id:asc. |
GET One Connection (GET /v1/connections/{id})
To return only one connection, you need the id of the connection. All request parameters are optional unless otherwise noted:
Input Parameter | Type | Required | Definition |
id | integer | Yes | The ID of the connection. |