fastly-api 13.1.0

Fastly API client
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
90
91
92
93

# EventsApi

> [!NOTE]
> All URIs are relative to `https://api.fastly.com`

Method | HTTP request | Description
------ | ------------ | -----------
[**get_event**](EventsApi.md#get_event) | **GET** /events/{event_id} | Get an event
[**list_events**](EventsApi.md#list_events) | **GET** /events | List events



## get_event

Get a specific event.

```rust
let cfg = &Configuration::default();
let params = GetEventParams {
    // parameters
};
get_event(cfg, params)
```

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**event_id** | **String** | Alphanumeric string identifying an event. | [required] |

### Return type

[**crate::models::EventResponse**](EventResponse.md)

### Authorization

[token](../README.md#token)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/vnd.api+json

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


## list_events

List all events for a particular customer. Events can be filtered by user, customer and event type. Events can be sorted by date.

```rust
let cfg = &Configuration::default();
let params = ListEventsParams {
    // parameters
};
list_events(cfg, params)
```

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**filter_customer_id** | Option\<**String**> | Limit the results returned to a specific customer. |  |
**filter_event_type** | Option\<**String**> | Limit the returned events to a specific `event_type`. |  |
**filter_service_id** | Option\<**String**> | Limit the results returned to a specific service. |  |
**filter_user_id** | Option\<**String**> | Limit the results returned to a specific user. |  |
**filter_token_id** | Option\<**String**> | Limit the returned events to a specific token. |  |
**filter_created_at** | Option\<**String**> | Limit the returned events to a specific time frame. Accepts sub-parameters: lt, lte, gt, gte (e.g., filter[created_at][gt]=2022-01-12).  |  |
**filter_created_at_lte** | Option\<**String**> | Return events on and before a date and time in ISO 8601 format.  |  |
**filter_created_at_lt** | Option\<**String**> | Return events before a date and time in ISO 8601 format.  |  |
**filter_created_at_gte** | Option\<**String**> | Return events on and after a date and time in ISO 8601 format.  |  |
**filter_created_at_gt** | Option\<**String**> | Return events after a date and time in ISO 8601 format.  |  |
**page_number** | Option\<**i32**> | Current page. |  |
**page_size** | Option\<**i32**> | Number of records per page. |  |[default to 20]
**sort** | Option\<**String**> | The order in which to list the results by creation date. |  |[default to created_at]

### Return type

[**crate::models::EventsResponse**](EventsResponse.md)

### Authorization

[token](../README.md#token)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/vnd.api+json

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