Skip to content

List Connectors

POST
/v2/connectors/list
 
curl --request POST \
  --url http://localhost:3000/v2/connectors/list \
  --header 'Content-Type: application/json' \
  --data '{ "id": "api.connectors.list", "ver": "v2", "ts": "2024-04-10T16:10:50+05:30", "params": { "msgid": "4a7f14c3-d61e-4d4f-be78-181834eeff6d" }, "request": { "filters": { "status": [ "Draft" ] } } }'

Request Body

Section titled “Request Body ”
Media type application/json
object
Example 
{
  "id": "api.connectors.list",
  "ver": "v2",
  "ts": "2024-04-10T16:10:50+05:30",
  "params": {
    "msgid": "4a7f14c3-d61e-4d4f-be78-181834eeff6d"
  },
  "request": {
    "filters": {
      "status": [
        "Draft"
      ]
    }
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
Examples

Success: Filtered based on status

{
  "id": "api.connectors.list",
  "ver": "v2",
  "ts": "2024-07-30T15:25:51+05:30",
  "params": {
    "status": "SUCCESS",
    "msgid": "4a7f14c3-d61e-4d4f-be78-181834eeff6d",
    "resmsgid": "f506e725-eed4-41df-86dc-2477d5c4d19a"
  },
  "responseCode": "OK",
  "result": {
    "data": [],
    "count": 0
  }
}

Headers

Section titled “Headers ”
X-Powered-By
string
Example 
Express
Content-Length
integer
Example 
250
ETag
string
Example 
W/"fa-+eWKIfUxsWBGuJy23qSucgLXke4"
Date
string
Example 
Tue, 30 Jul 2024 09:55:51 GMT
Connection
string
Example 
keep-alive
Keep-Alive
string
Example 
timeout=5

400

Section titled “400 ”

Bad Request

Media type application/json
object
Example 
{
  "id": "api.connectors.list",
  "ver": "v2",
  "ts": "2024-07-30T15:13:14+05:30",
  "params": {
    "status": "FAILED",
    "msgid": "4a7f14c3-d61e-4d4f-be78-181834eeff6d",
    "resmsgid": "02fadde0-8c59-4420-8ab3-56474b01670b"
  },
  "responseCode": "BAD_REQUEST",
  "result": {},
  "error": {
    "code": "CONNECTORS_LIST_INPUT_INVALID",
    "message": "#properties/request/properties/filters/properties/status/minItems must NOT have fewer than 1 items"
  }
}

Headers

Section titled “Headers ”
X-Powered-By
string
Example 
Express
Content-Length
integer
Example 
399
ETag
string
Example 
W/"18f-Hsau3RTrCuWgbSoS3cqIWuUq45k"
Date
string
Example 
Tue, 30 Jul 2024 09:43:14 GMT
Connection
string
Example 
keep-alive
Keep-Alive
string
Example 
timeout=5