Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-144317.9 KB

get/v1/Alerts/{Sid}

Path parameters

Sidstring required

The SID of the Alert resource to fetch.

Response

OK

account_sidstring nullable

The SID of the Account that created the Alert resource.

alert_textstring nullable

The text of the alert.

api_versionstring nullable

The API version used when the alert was generated. Can be empty for events that don't have a specific API version.

date_createdstring date-time nullable

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_generatedstring date-time nullable

The date and time in GMT when the alert was generated specified in ISO 8601 format. Due to buffering, this can be different than date_created.

date_updatedstring date-time nullable

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

error_codestring nullable

The error code for the condition that generated the alert. See the Error Dictionary for possible causes and solutions to the error.

log_levelstring nullable

The log level. Can be: error, warning, notice, or debug.

more_infostring nullable

The URL of the page in our Error Dictionary with more information about the error condition.

request_headersstring nullable

The request headers of the request that generated the alert. This value is only returned when a single Alert resource is fetched.

request_method'HEAD' | 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE' http-method nullable

The method used by the request that generated the alert. If the alert was generated by a request we made to your server, this is the method we used. If the alert was generated by a request from your application to our API, this is the method your application used.

request_urlstring nullable

The URL of the request that generated the alert. If the alert was generated by a request we made to your server, this is the URL on your server that generated the alert. If the alert was generated by a request from your application to our API, this is the URL of the resource requested.

request_variablesstring nullable

The variables passed in the request that generated the alert. This value is only returned when a single Alert resource is fetched.

resource_sidstring nullable

The SID of the resource for which the alert was generated. For instance, if your server failed to respond to an HTTP request during the flow of a particular call, this value would be the SID of the server. This value is empty if the alert was not generated for a particular resource.

response_bodystring nullable

The response body of the request that generated the alert. This value is only returned when a single Alert resource is fetched.

response_headersstring nullable

The response headers of the request that generated the alert. This value is only returned when a single Alert resource is fetched.

service_sidstring nullable

The SID of the service or resource that generated the alert. Can be null.

sidstring nullable

The unique string that we created to identify the Alert resource.

urlstring uri nullable

The absolute URL of the Alert resource.