PLplastic-labs
peers

Update Peer

Changed on

Update a Peer's metadata and/or configuration.

Returns 422 if the peer is a scope — use the scopes routes to manage scopes.

put/v3/workspaces/{workspace_id}/peers/{peer_id}

Request

  • Base URL
    https://api.honcho.dev
  • Auth
    HTTP bearer

Path parameters

workspace_idstring required
peer_idstring required

Request body

metadataobject nullable
configurationobject nullable

Response

Successful Response

idstring required
uidstring required

Immutable identifier Honcho assigns to this peer. id is the name the client chose; uid is generated by the server.

workspace_idstring required
created_atstring date-time required
metadataobject
configurationobject

Changes

  • v3c10fbe693a00Revision changes
    • info

      added the required property to the response with the status

  • v30730be052dc9Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status