Portal Links

Create a portal link

Changed on

This endpoint creates a portal link

post/v1/projects/{projectID}/portal-links

Request

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

Path parameters

projectIDstring required

Project 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

Created

messagestring
statusboolean

Changes