Showing 25 blocks

get: agent

Returns the currently connected user agent.


In pins

connection

Out pins

agent

get: body

Returns the provided body as object, if the request method is POST or PUT.


In pins

connection

Out pins

body

response: end writestream

Ends the current open stream with the client.


In pins

flow
connection

Out pins

flow
connection

get: get scopes

Returns the authenticated user scope.


In pins

connection

Out pins

scopes

get: header

Gets the given header if present in HTTP request.


In pins

connection
name

Out pins

value

get: headers

Returns all headers known to us in the HTTP request.


In pins

connection

Out pins

headers

get: ip

Returns the currently connected user IP.


In pins

connection

Out pins

ip

get: is authenticated

Returns true if the user is authenticated.


In pins

connection

Out pins

authenticated

get: is root user

Returns true if the authenticated user has wildcard (*) scope.


In pins

connection

Out pins

is root

get: params

Returns all params if present, params are optional or required parameters in API URIs, for example :name.


In pins

connection

Out pins

params

get: query

Returns all query items if present. Query items may be given in the URI like ?query=yes.


In pins

connection

Out pins

query

response: redirect

Updates the connection to a new endpoint if the client allows following redirects.


In pins

flow
connection
uri
Redirects to the URL derived from the specified path. Could be back to redirect to the referer.

Out pins

flow
connection

API: register DELETE

In pins

flow
Yes
v10.3.2
URI
URI part after /api/, e.g. customers/get/all will become /api/{version}/customers/get/all.
scope
Yes
v10.3.2
Scope required within the authenticated user scopes to access this API, use `*public` to make this a public API.
version (optional)
v1
Version used in the API URI.

Out pins

flow
Yes
v10.3.2
On Request

API: register GET

In pins

flow
Yes
v10.3.2
URI
URI part after /api/, e.g. customers/get/all will become /api/{version}/customers/get/all.
scope
Yes
v10.3.2
Scope required within the authenticated user scopes to access this API, use `*public` to make this a public API.
version (optional)
v1
Version used in the API URI.

Out pins

flow
Yes
v10.3.2
On Request

API: register PATCH

In pins

flow
Yes
v10.3.2
URI
URI part after /api/, e.g. customers/get/all will become /api/{version}/customers/get/all.
scope
Yes
v10.3.2
Scope required within the authenticated user scopes to access this API, use `*public` to make this a public API.
version (optional)
v1
Version used in the API URI.

Out pins

flow
Yes
v10.3.2
On Request

API: register POST

In pins

flow
Yes
v10.3.2
URI
URI part after /api/, e.g. customers/get/all will become /api/{version}/customers/get/all.
scope
Yes
v10.3.2
Scope required within the authenticated user scopes to access this API, use `*public` to make this a public API.
version (optional)
v1
Version used in the API URI.

Out pins

flow
Yes
v10.3.2
On Request

API: register PUT

In pins

flow
Yes
v10.3.2
URI
URI part after /api/, e.g. customers/get/all will become /api/{version}/customers/get/all.
scope
Yes
v10.3.2
Scope required within the authenticated user scopes to access this API, use `*public` to make this a public API.
version (optional)
v1
Version used in the API URI.

Out pins

flow
Yes
v10.3.2
On Request

response: reply as file

In pins

flow
connection
code
HTTP Status Code to return on this response.
Headers (optional)
Custom HTTP Headers to set, Array of Objects [{ key: Value, value: Value }]
root
Root directory for relative filenames. Access to files will be restricted to this folder and its subfolders. Make sure the filepath does not contain the root. This should not be dynamic due to security reasons.
Filepath

Out pins

flow
connection

response: reply in JSON

In pins

flow
connection
code
HTTP Status Code to return on this response.
type (optional)
application/json
Sets the Content-Type HTTP header.
Headers (optional)
Custom HTTP Headers to set, Array of Objects [{ key: Value, value: Value }]
data
Yes
v9.4.4
Object, Array or any type casted to value.

Out pins

flow
connection

response: reply in JSONP

In pins

flow
connection
code
HTTP Status Code to return on this response.
Headers (optional)
Custom HTTP Headers to set, Array of Objects [{ key: Value, value: Value }]
callback
callback
The name of the callback function

Out pins

flow
connection

response: Reply in text

In pins

flow
connection
code
HTTP Status Code to return on this response.
type (optional)
plain/text
Sets the Content-Type HTTP header.
Headers (optional)
Custom HTTP Headers to set, Array of Objects [{ key: Value, value: Value }]
data

Out pins

flow
connection

response: reply in XML

In pins

flow
connection
type (optional)
text/xml
Sets the Content-Type HTTP header.
Headers (optional)
Custom HTTP Headers to set, Array of Objects [{ key: Value, value: Value }]
XML Root
data

Out pins

flow
connection

get: request id

Returns the unique request ID

v10.4.18

In pins

connection

Out pins

ID

response: timeout

Updates the default connection timeout of 120 seconds

v10.3.11

In pins

flow
connection
seconds
Number of seconds the connection should wait before closing, a number between 1 and 600. We currently do not allow connections to exceed 10 minutes of wait time.

Out pins

flow
connection

response: write to stream

Writes part of a response to the client. After the whole response has been streamed, we need to call end stream.


In pins

flow
connection
code
HTTP Status Code to return on this response.
type (optional)
plain/text
Sets the Content-Type HTTP header.
Headers (optional)
Custom HTTP Headers to set, Array of Objects [{ key: Value, value: Value }]
Chunk
Writes part of a response to the client. After the whole response has been streamed, we need to call end stream.

Out pins

flow
connection

Groups