FRfrain-dev
Portal Links

Update a portal link

Changed on

This endpoint updates a portal link

put/v1/projects/{projectID}/portal-links/{portalLinkID}

Request

  • Base URL
    https://us.getconvoy.cloud/api
  • Auth
    API key in header Authorization

Path parameters

projectIDstring required

Project ID

portalLinkIDstring required

portal link id

Request body

auth_typestring
can_manage_endpointboolean

Specify whether endpoint management can be done through the Portal Link UI

endpointsstring[]

Deprecated IDs of endpoints in this portal link

namestring

Portal Link Name

owner_idstring

OwnerID, the portal link will inherit all the endpoints with this owner ID

Response

Accepted

messagestring
statusboolean

Changes