preheat

Get a P2P provider instance

get/p2p/preheat/instances/{preheat_instance_name}

Path parameters

preheat_instance_namestring required

Instance Name

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.