Skip to content

incident_io_client.api.alert_events_v2.alert_events_v2_create_http

asyncio async 

asyncio(
    alert_source_config_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
    body: AlertEventsV2CreateHTTPRequestBody,
    token: Union[Unset, str] = UNSET,
    authorization: Union[Unset, str] = UNSET
) -> Optional[AlertResult]

CreateHTTP Alert Events V2

Create an alert event using an HTTP source.

Parameters:

Name Type Description Default
alert_source_config_id str
required
token Union[Unset, str]
UNSET
authorization Union[Unset, str]
UNSET
body AlertEventsV2CreateHTTPRequestBody

Example: {'deduplication_key': '4293868629', 'description': "We've detected a number of timeouts on hello.world.com, the service may be down. To fix...", 'metadata': {'service': 'hello.world.com', 'team': ['my-team']}, 'source_url': 'https://www.my-alerting-platform.com/alerts/my-alert-123', 'status': 'firing', 'title': '*errors.withMessage: PG::Error failed to connect'}.

 required

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Optional[AlertResult]

AlertResult
Source code in incident_io_client/api/alert_events_v2/alert_events_v2_create_http.py 
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
async def asyncio(
    alert_source_config_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
    body: AlertEventsV2CreateHTTPRequestBody,
    token: Union[Unset, str] = UNSET,
    authorization: Union[Unset, str] = UNSET,
) -> Optional[AlertResult]:
    """CreateHTTP Alert Events V2

     Create an alert event using an HTTP source.

    Args:
        alert_source_config_id (str):
        token (Union[Unset, str]):
        authorization (Union[Unset, str]):
        body (AlertEventsV2CreateHTTPRequestBody):  Example: {'deduplication_key': '4293868629',
            'description': "We've detected a number of timeouts on hello.world.com, the service may be
            down. To fix...", 'metadata': {'service': 'hello.world.com', 'team': ['my-team']},
            'source_url': 'https://www.my-alerting-platform.com/alerts/my-alert-123', 'status':
            'firing', 'title': '*errors.withMessage: PG::Error failed to connect'}.

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        AlertResult
    """

    return (
        await asyncio_detailed(
            alert_source_config_id=alert_source_config_id,
            client=client,
            body=body,
            token=token,
            authorization=authorization,
        )
    ).parsed

asyncio_detailed async 

asyncio_detailed(
    alert_source_config_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
    body: AlertEventsV2CreateHTTPRequestBody,
    token: Union[Unset, str] = UNSET,
    authorization: Union[Unset, str] = UNSET
) -> Response[AlertResult]

CreateHTTP Alert Events V2

Create an alert event using an HTTP source.

Parameters:

Name Type Description Default
alert_source_config_id str
required
token Union[Unset, str]
UNSET
authorization Union[Unset, str]
UNSET
body AlertEventsV2CreateHTTPRequestBody

Example: {'deduplication_key': '4293868629', 'description': "We've detected a number of timeouts on hello.world.com, the service may be down. To fix...", 'metadata': {'service': 'hello.world.com', 'team': ['my-team']}, 'source_url': 'https://www.my-alerting-platform.com/alerts/my-alert-123', 'status': 'firing', 'title': '*errors.withMessage: PG::Error failed to connect'}.

 required

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Response[AlertResult]

Response[AlertResult]
Source code in incident_io_client/api/alert_events_v2/alert_events_v2_create_http.py 
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
async def asyncio_detailed(
    alert_source_config_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
    body: AlertEventsV2CreateHTTPRequestBody,
    token: Union[Unset, str] = UNSET,
    authorization: Union[Unset, str] = UNSET,
) -> Response[AlertResult]:
    """CreateHTTP Alert Events V2

     Create an alert event using an HTTP source.

    Args:
        alert_source_config_id (str):
        token (Union[Unset, str]):
        authorization (Union[Unset, str]):
        body (AlertEventsV2CreateHTTPRequestBody):  Example: {'deduplication_key': '4293868629',
            'description': "We've detected a number of timeouts on hello.world.com, the service may be
            down. To fix...", 'metadata': {'service': 'hello.world.com', 'team': ['my-team']},
            'source_url': 'https://www.my-alerting-platform.com/alerts/my-alert-123', 'status':
            'firing', 'title': '*errors.withMessage: PG::Error failed to connect'}.

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Response[AlertResult]
    """

    kwargs = _get_kwargs(
        alert_source_config_id=alert_source_config_id,
        body=body,
        token=token,
        authorization=authorization,
    )

    response = await client.get_async_httpx_client().request(**kwargs)

    return _build_response(client=client, response=response)

sync 

sync(
    alert_source_config_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
    body: AlertEventsV2CreateHTTPRequestBody,
    token: Union[Unset, str] = UNSET,
    authorization: Union[Unset, str] = UNSET
) -> Optional[AlertResult]

CreateHTTP Alert Events V2

Create an alert event using an HTTP source.

Parameters:

Name Type Description Default
alert_source_config_id str
required
token Union[Unset, str]
UNSET
authorization Union[Unset, str]
UNSET
body AlertEventsV2CreateHTTPRequestBody

Example: {'deduplication_key': '4293868629', 'description': "We've detected a number of timeouts on hello.world.com, the service may be down. To fix...", 'metadata': {'service': 'hello.world.com', 'team': ['my-team']}, 'source_url': 'https://www.my-alerting-platform.com/alerts/my-alert-123', 'status': 'firing', 'title': '*errors.withMessage: PG::Error failed to connect'}.

 required

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Optional[AlertResult]

AlertResult
Source code in incident_io_client/api/alert_events_v2/alert_events_v2_create_http.py 
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
def sync(
    alert_source_config_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
    body: AlertEventsV2CreateHTTPRequestBody,
    token: Union[Unset, str] = UNSET,
    authorization: Union[Unset, str] = UNSET,
) -> Optional[AlertResult]:
    """CreateHTTP Alert Events V2

     Create an alert event using an HTTP source.

    Args:
        alert_source_config_id (str):
        token (Union[Unset, str]):
        authorization (Union[Unset, str]):
        body (AlertEventsV2CreateHTTPRequestBody):  Example: {'deduplication_key': '4293868629',
            'description': "We've detected a number of timeouts on hello.world.com, the service may be
            down. To fix...", 'metadata': {'service': 'hello.world.com', 'team': ['my-team']},
            'source_url': 'https://www.my-alerting-platform.com/alerts/my-alert-123', 'status':
            'firing', 'title': '*errors.withMessage: PG::Error failed to connect'}.

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        AlertResult
    """

    return sync_detailed(
        alert_source_config_id=alert_source_config_id,
        client=client,
        body=body,
        token=token,
        authorization=authorization,
    ).parsed

sync_detailed 

sync_detailed(
    alert_source_config_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
    body: AlertEventsV2CreateHTTPRequestBody,
    token: Union[Unset, str] = UNSET,
    authorization: Union[Unset, str] = UNSET
) -> Response[AlertResult]

CreateHTTP Alert Events V2

Create an alert event using an HTTP source.

Parameters:

Name Type Description Default
alert_source_config_id str
required
token Union[Unset, str]
UNSET
authorization Union[Unset, str]
UNSET
body AlertEventsV2CreateHTTPRequestBody

Example: {'deduplication_key': '4293868629', 'description': "We've detected a number of timeouts on hello.world.com, the service may be down. To fix...", 'metadata': {'service': 'hello.world.com', 'team': ['my-team']}, 'source_url': 'https://www.my-alerting-platform.com/alerts/my-alert-123', 'status': 'firing', 'title': '*errors.withMessage: PG::Error failed to connect'}.

 required

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Response[AlertResult]

Response[AlertResult]
Source code in incident_io_client/api/alert_events_v2/alert_events_v2_create_http.py 
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
def sync_detailed(
    alert_source_config_id: str,
    *,
    client: Union[AuthenticatedClient, Client],
    body: AlertEventsV2CreateHTTPRequestBody,
    token: Union[Unset, str] = UNSET,
    authorization: Union[Unset, str] = UNSET,
) -> Response[AlertResult]:
    """CreateHTTP Alert Events V2

     Create an alert event using an HTTP source.

    Args:
        alert_source_config_id (str):
        token (Union[Unset, str]):
        authorization (Union[Unset, str]):
        body (AlertEventsV2CreateHTTPRequestBody):  Example: {'deduplication_key': '4293868629',
            'description': "We've detected a number of timeouts on hello.world.com, the service may be
            down. To fix...", 'metadata': {'service': 'hello.world.com', 'team': ['my-team']},
            'source_url': 'https://www.my-alerting-platform.com/alerts/my-alert-123', 'status':
            'firing', 'title': '*errors.withMessage: PG::Error failed to connect'}.

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Response[AlertResult]
    """

    kwargs = _get_kwargs(
        alert_source_config_id=alert_source_config_id,
        body=body,
        token=token,
        authorization=authorization,
    )

    response = client.get_httpx_client().request(
        **kwargs,
    )

    return _build_response(client=client, response=response)