cortex-client 0.1.1

API for Cortex, a powerful observable analysis and active response engine.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

# \StreamApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_stream**](StreamApi.md#create_stream) | **POST** /stream | Create a new event stream
[**get_stream_events**](StreamApi.md#get_stream_events) | **GET** /stream/{id} | Get events from a stream
[**get_stream_session_status**](StreamApi.md#get_stream_session_status) | **GET** /stream/status | Get the status of the current session/token for streaming



## create_stream

> String create_stream()
Create a new event stream

### Parameters

This endpoint does not need any parameter.

### Return type

**String**

### Authorization

[SessionAuth](../README.md#SessionAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain, application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_stream_events

> models::StreamMessagesResponse get_stream_events(id)
Get events from a stream

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | The ID of the stream. | [required] |

### Return type

[**models::StreamMessagesResponse**](StreamMessagesResponse.md)

### Authorization

[SessionAuth](../README.md#SessionAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_stream_session_status

> models::StreamStatusResponse get_stream_session_status()
Get the status of the current session/token for streaming

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::StreamStatusResponse**](StreamStatusResponse.md)

### Authorization

[SessionAuth](../README.md#SessionAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)