API Reference
External log drain configuration and management
List log drains
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Query Parameters
project_id*string
Response Body
application/json
curl -X GET "http://localhost:8080/v1/log-drains?project_id=string"[
{
"id": "string",
"project_id": "string",
"name": "string",
"drain_type": "string",
"endpoint_url": "string",
"auth_type": "string",
"auth_config": {
"property1": "string",
"property2": "string"
},
"level_filter": [
"string"
],
"enabled": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]Create a log drain
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "http://localhost:8080/v1/log-drains" \ -H "Content-Type: application/json" \ -d '{ "project_id": "string", "name": "string", "drain_type": "string", "endpoint_url": "string", "auth_type": "string" }'{
"id": "string",
"project_id": "string",
"name": "string",
"drain_type": "string",
"endpoint_url": "string",
"auth_type": "string",
"auth_config": {
"property1": "string",
"property2": "string"
},
"level_filter": [
"string"
],
"enabled": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}Get a log drain
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
drainID*string
Query Parameters
project_id*string
Response Body
application/json
curl -X GET "http://localhost:8080/v1/log-drains/string?project_id=string"{
"id": "string",
"project_id": "string",
"name": "string",
"drain_type": "string",
"endpoint_url": "string",
"auth_type": "string",
"auth_config": {
"property1": "string",
"property2": "string"
},
"level_filter": [
"string"
],
"enabled": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}Update a log drain
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
drainID*string
Query Parameters
project_id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PATCH "http://localhost:8080/v1/log-drains/string?project_id=string" \ -H "Content-Type: application/json" \ -d '{}'{
"id": "string",
"project_id": "string",
"name": "string",
"drain_type": "string",
"endpoint_url": "string",
"auth_type": "string",
"auth_config": {
"property1": "string",
"property2": "string"
},
"level_filter": [
"string"
],
"enabled": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}Delete a log drain
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
drainID*string
Query Parameters
project_id*string
Response Body
curl -X DELETE "http://localhost:8080/v1/log-drains/string?project_id=string"Empty
Was this page helpful?