preheat

Update the specified P2P provider instance

Update the specified P2P provider instance.

If auth_info is omitted or empty in the request body and the effective auth_mode is not NONE (either sent in the request or left unchanged from the stored registration), the previously stored auth credentials are kept. Send a non-empty auth_info object to set or replace credentials. Set auth_mode to NONE to disable authentication without retaining the old credentials.

put/p2p/preheat/instances/{preheat_instance_name}

Path parameters

preheat_instance_namestring required

Instance Name

Headers

X-Request-Idstring

An unique ID for the request

Request body

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

Response

Success

Changes

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