Presets_list
const url = 'http://localhost:3000/api/presets';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url http://localhost:3000/api/presets \ --header 'Authorization: Bearer <token>'List the Presets the Instance offers, with the params schema of each
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”The request has succeeded.
Paginated response
object
List of items
A Preset: how an Instance verifies and reads one provider’s bounce and complaint callbacks
object
The name an Integration’s preset refers to
What the Preset is for
JSON Schema (draft 2020-12) of the params an Integration of this Preset takes. A string marked writeOnly is a secret: it is never returned by a read.
object
Page number (1-based)
Page size
Total number of elements
Total number of pages
Example generated
{ "items": [ { "name": "example", "description": "example", "paramsSchema": { "additionalProperty": "example" } } ], "page": 1, "pageSize": 1, "totalItems": 1, "totalPages": 1}RFC 7807 unauthorized response
RFC 7807 Problem Details
object
Why the request was refused, when the client should act on it
A URI reference that identifies the problem type
A short, human-readable summary of the problem type
HTTP status code
A human-readable explanation specific to this occurrence
A URI reference that identifies the specific occurrence
Validation errors grouped by field
object
Form-level validation error
Field validation errors
object
Seconds to wait before retrying; set on a 429 so a client that only sees the body can show the wait
Why a 500 happened, sent only by a development server (SPHERICON_ENV=development)
object
The error that failed the request, or the panic value
The goroutine stack of a panic; absent for an error a handler returned
The request id the server log carries for this request
The HTTP method of the failed request
The path of the failed request
Example
{ "code": "second_factor_required"}RFC 7807 too many requests response: a rate limit was exceeded (ADR 0025)
RFC 7807 Problem Details
object
Why the request was refused, when the client should act on it
A URI reference that identifies the problem type
A short, human-readable summary of the problem type
HTTP status code
A human-readable explanation specific to this occurrence
A URI reference that identifies the specific occurrence
Validation errors grouped by field
object
Form-level validation error
Field validation errors
object
Seconds to wait before retrying; set on a 429 so a client that only sees the body can show the wait
Why a 500 happened, sent only by a development server (SPHERICON_ENV=development)
object
The error that failed the request, or the panic value
The goroutine stack of a panic; absent for an error a handler returned
The request id the server log carries for this request
The HTTP method of the failed request
The path of the failed request
Example
{ "code": "second_factor_required"}Headers
Section titled “Headers”Seconds to wait before retrying
The request budget of the window that was exceeded
Requests left in the current window
Unix time at which the window resets