Sign in
preheat

List P2P provider instances

List P2P provider instances

get/p2p/preheat/instances

Query parameters

pageinteger

The page number

page_sizeinteger

The size of per page

qstring

Query string to query resources. Supported query patterns are "exact match(k=v)", "fuzzy match(k=v)", "range(k=[minmax])", "list with union releationship(k={v1 v2 v3})" and "list with intersetion relationship(k=(v1 v2 v3))". The value of range and list can be string(enclosed by " or '), integer or time(in format "2020-04-09 02:36:00"). All of these query patterns should be put in the query string "q=xxx" and splitted by ",". e.g. q=k1=v1,k2=v2,k3=[minmax]

sortstring

Sort the resource list in ascending or descending order. e.g. sort by field1 in ascending order and field2 in descending order with "sort=field1,-field2"

Headers

X-Request-Idstring

An unique ID for the request

Response

Success

idinteger

Unique ID

namestring

Instance name

descriptionstring

Description of instance

vendorstring

Based on which driver, identified by ID

endpointstring

The service endpoint of this instance

auth_modestring

The authentication way supported

auth_infoobject

The auth credential data if it exists.

When updating an instance (PUT /p2p/preheat/instances/{preheat_instance_name}), if this object is omitted or empty and auth_mode is not NONE, the previously stored credentials are kept.

statusstring

The health status

enabledboolean

Whether the instance is activated or not

defaultboolean

Whether the instance is default or not

insecureboolean

Whether the instance endpoint is insecure or not

setup_timestampinteger

The timestamp of instance setting up

Changes

No recorded changes to this endpoint across all 1 revision of this API.