GEgetconvoy
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
    HTTP bearer

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

  • v3c6c04abdfb6fRevision changes
    • info

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

  • v3bae289777c91Revision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the /// response's property type changed from object to no type for status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      added the new enum value to the // response property for the response status

    • info

      added to the /// response property allOf list for the response status

    • info

      added to the / response property allOf list for the response status

    • info

      added to the / response property allOf list for the response status

    • info

      added to the / response property allOf list for the response status