Home Schema Example JSON Schema

Request Settings

Type: object

These additional settings will be used with HTTPS source URLs in the request.

 No Additional Properties

root method

Method

Type: enum (of string)

Request method. Defaults to incoming request method.

Must be one of:

  • "get"
  • "post"
  • "put"
  • "patch"
  • "delete"
  • "head"
  • "options"

root params

Params


Dictionary or string (will be sent as-is) to send in the query string for the Request.

root params oneOf Dictionary

Dictionary

Type: object

Each additional property must conform to the following schema

root params oneOf Dictionary additionalProperties
Type: string
root params oneOf String

String

Type: string

root json

JSON

Type: object

A JSON serializable Python object to send in the body of the Request.

root headers

Headers

Type: object

Dictionary of HTTP Headers to send with the Request.

Each additional property must conform to the following schema

root headers additionalProperties
Type: string

root auth

Auth

Type: array

Auth tuple to enable Basic HTTP Auth.

 No Additional Items

Tuple Validation

Item at 1 must be:
root auth User

User

Type: string
Item at 2 must be:
root auth Password

Password

Type: string

root allow_redirects

Allow Redirects

Type: boolean

Enable/disable GET/OPTIONS/POST/PUT/PATCH/DELETE/HEAD redirection. Defaults to true.

root timeout

Timeout

Type: number

How many seconds to wait for the server to send data before giving up. Defaults to 3.