CustomAPIRequestConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)Configuration for the outgoing API request.
Attributes |
|
|---|---|
| Name | Description |
endpoint_path |
str
Required. Enter the specific API route appended to the Base URL to fetch the data (e.g., /v1/alerts). |
http_method |
google.cloud.chronicle_v1.types.CustomAPIRequestConfig.HttpMethod
Required. Select the type of action to perform on the API endpoint (usually GET to retrieve data or POST to submit a query). |
request_body |
str
Optional. Provide the data payload sent to the API to specify what information you want, typically formatted in JSON. |
query_parameters |
MutableSequence[google.cloud.chronicle_v1.types.HeaderKeyValue]
Optional. Add extra filters or settings appended to the end of the URL (e.g., ?status=critical). |
custom_headers |
MutableSequence[google.cloud.chronicle_v1.types.HeaderKeyValue]
Optional. Define specialized key-value pairs sent with the request, often used for custom API versioning or specific vendor requirements. |
max_requests_per_minute |
int
Optional. Set a safety limit to ensure the connector does not exceed the third-party vendor's API rate limits. |
Classes
HttpMethod
HttpMethod(value)HTTPS methods supported.