PUT
/
v1
/
projects
/
{projectID}
/
portal-links
/
{portalLinkID}
curl --request PUT \
  --url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/portal-links/{portalLinkID} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "can_manage_endpoint": true,
  "endpoints": [
    "<string>"
  ],
  "name": "<string>",
  "owner_id": "<string>"
}'
{
  "message": "<string>",
  "status": true,
  "data": {
    "can_manage_endpoint": true,
    "created_at": "<string>",
    "deleted_at": "<string>",
    "endpoint_count": 123,
    "endpoints": [
      "<string>"
    ],
    "endpoints_metadata": [
      {
        "advanced_signatures": true,
        "authentication": {
          "api_key": {
            "header_name": "<string>",
            "header_value": "<string>"
          },
          "type": "api_key"
        },
        "created_at": "<string>",
        "deleted_at": "<string>",
        "description": "<string>",
        "events": 123,
        "http_timeout": 123,
        "name": "<string>",
        "owner_id": "<string>",
        "project_id": "<string>",
        "rate_limit": 123,
        "rate_limit_duration": 123,
        "secrets": [
          {
            "created_at": "<string>",
            "deleted_at": "<string>",
            "expires_at": "<string>",
            "uid": "<string>",
            "updated_at": "<string>",
            "value": "<string>"
          }
        ],
        "slack_webhook_url": "<string>",
        "status": "active",
        "support_email": "<string>",
        "uid": "<string>",
        "updated_at": "<string>",
        "url": "<string>"
      }
    ],
    "name": "<string>",
    "owner_id": "<string>",
    "project_id": "<string>",
    "token": "<string>",
    "uid": "<string>",
    "updated_at": "<string>",
    "url": "<string>"
  }
}

Authorizations

Authorization
string
headerrequired

Path Parameters

projectID
string
required

Project ID

portalLinkID
string
required

portal link id

Body

application/json
can_manage_endpoint
boolean

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

endpoints
string[]

IDs of endpoints in this portal link

name
string

Portal Link Name

owner_id
string

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

Response

200 - application/json
message
string
status
boolean
data
object