Destinations

GET /v1/destination/{id}

Description

Get info for one destination.

Header Parameters

Param	Type	Required	Description
Authorization	string	yes	Bearer token containing API key

Path Parameters

Param	Type	Required	Description
TODO	string	yes	Bearer token containing API key

Example Response

{
   "0dce7d85-8d61-41db-86bd-af005df755f4":{
      "latency_ms":0,
      "status":"error",
      "message":"Failed to connect",
      "last_checked_at":1624548189
   }
}

GET /v1/destination

Description

Get info about all destinations.

Header Parameters

Param	Type	Required	Description
Authorization	string	yes	Bearer token containing API key

Example Response

{
   "0dce7d85-8d61-41db-86bd-af005df755f4":{
      "latency_ms":0,
      "status":"error",
      "message":"Failed to connect",
      "last_checked_at":1624548189
   }
}

POST /v1/destination

Description

Create a Kafka destination.

Header Parameters

Param	Type	Required	Description
Authorization	string	yes	Bearer token containing API key

Body Parameters

{
  "name": "New destination",
  "team_id": "554dfc24-413f-46d8-b38c-1e15efe439cf",
  "notes": "New destination notes",
  "type": "kafka",
  "metadata": {
      "topic": "test",
      "address": "localhost:9092",
      "use_tls": false,
    "insecure_tls": false,
    "sasl_type": "scram",
    "username": "batchsh",
    "password": "solarwinds123"
  }
}

Example Response

{
   "0dce7d85-8d61-41db-86bd-af005df755f4":{
      "latency_ms":0,
      "status":"error",
      "message":"Failed to connect",
      "last_checked_at":1624548189
   }
}

POST /v1/destination

Description

Header Parameters

Param	Type	Required	Description
Authorization	string	yes	Bearer token containing API key

Body Parameters

{
  "name": "test http",
  "team_id": "9c3d4691-1788-46fd-a30f-8eb0b66cb5e1",
  "notes": "some notes",
  "type": "http",
  "metadata": {
    "headers": [
      {
        "content-type": "text/plain"
      }
    ],
    "url": "http://batch.sh"
  }
}

Example Response

{
   "0dce7d85-8d61-41db-86bd-af005df755f4":{
      "latency_ms":0,
      "status":"error",
      "message":"Failed to connect",
      "last_checked_at":1624548189
   }
}

POST /v1/destination

Description

Create a Redis PubSub destination.

Header Parameters

Param	Type	Required	Description
Authorization	string	yes	Bearer token containing API key

Body Parameters

Param	Type	Required	Description
TODO	string	yes	Bearer token containing API key

Example Response

{
   "0dce7d85-8d61-41db-86bd-af005df755f4":{
      "latency_ms":0,
      "status":"error",
      "message":"Failed to connect",
      "last_checked_at":1624548189
   }
}

POST - /v1/destination

Description

Create a Redis Streams destination.

Header Parameters

Param	Type	Required	Description
Authorization	string	yes	Bearer token containing API key

Body Parameters

Param	Type	Required	Description
TODO	string	yes	Bearer token containing API key

Example Response

{
   "0dce7d85-8d61-41db-86bd-af005df755f4":{
      "latency_ms":0,
      "status":"error",
      "message":"Failed to connect",
      "last_checked_at":1624548189
   }
}

PUT /v1/destination

Description

Update a destination.

Header Parameters

Param	Type	Required	Description
Authorization	string	yes	Bearer token containing API key

Body Parameters

Param	Type	Required	Description
TODO	string	yes	Bearer token containing API key

Example Response

{
   "0dce7d85-8d61-41db-86bd-af005df755f4":{
      "latency_ms":0,
      "status":"error",
      "message":"Failed to connect",
      "last_checked_at":1624548189
   }
}

DELETE /v1/destination

Description

Delete a destination.

Header Parameters

Param	Type	Required	Description
Authorization	string	yes	Bearer token containing API key

Body Parameters

Param	Type	Required	Description
TODO	string	yes	Bearer token containing API key

Example Response

{
   "0dce7d85-8d61-41db-86bd-af005df755f4":{
      "latency_ms":0,
      "status":"error",
      "message":"Failed to connect",
      "last_checked_at":1624548189
   }
}

GET /v1/verify-destination/{id}

Description

Validate that Batch is able to access a newly created destination.

Header Parameters

Param	Type	Required	Description
Authorization	string	yes	Bearer token containing API key

Path Parameters

Param	Type	Required	Description
TODO	string	yes	Bearer token containing API key

Example Response

{
   "0dce7d85-8d61-41db-86bd-af005df755f4":{
      "latency_ms":0,
      "status":"error",
      "message":"Failed to connect",
      "last_checked_at":1624548189
   }
}