Portal Links
Update a portal link
- Community
- GitHub
- Tutorials
- GETList all endpoints
- POSTCreate an endpoint
- GETRetrieve endpoint
- PUTUpdate an endpoint
- DELDelete endpoint
- PUTRoll endpoint secret
- PUTPause endpoint
- GETList all event deliveries
- POSTBatch retry event delivery
- POSTForce retry event delivery
- GETRetrieve an event delivery
- PUTRetry event delivery
- GETList all events
- POSTCreate an event
- POSTCreate a broadcast event
- POSTBatch replay events
- POSTDynamic Events
- POSTFan out an event
- GETRetrieve an event
- PUTReplay event
- GETList all portal links
- POSTCreate a portal link
- GETRetrieve a portal link
- PUTUpdate a portal link
- PUTRevoke a portal link
Endpoints
Event Deliveries
Events
Portal Links
Portal Links
Update a portal link
This endpoint updates a portal link
PUT
/
v1
/
projects
/
{projectID}
/
portal-links
/
{portalLinkID}
Authorization
string
*
Authorization
Required
string
projectID
string
*
projectID
Required
string
Project ID
portalLinkID
string
*
portalLinkID
Required
string
portal link id
object
*
can_manage_endpoint
boolean
can_manage_endpoint
boolean
Specify whether endpoint management can be done through the Portal Link UI
endpoints
array
endpoints
array
IDs of endpoints in this portal link
name
string
name
string
Portal Link Name
owner_id
string
owner_id
string
Alternatively specify OwnerID, the portal link will inherit all the endpoints with this owner ID
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
headerrequiredPath Parameters
projectID
string
requiredProject ID
portalLinkID
string
requiredportal 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
data.can_manage_endpoint
boolean
data.created_at
string
data.deleted_at
string
data.endpoint_count
integer
data.endpoints
string[]
data.endpoints_metadata
object[]
data.endpoints_metadata.advanced_signatures
boolean
data.endpoints_metadata.authentication
object
data.endpoints_metadata.authentication.api_key
object
data.endpoints_metadata.authentication.api_key.header_name
string
data.endpoints_metadata.authentication.api_key.header_value
string
data.endpoints_metadata.authentication.type
enum<string>
Available options:
api_key
data.endpoints_metadata.created_at
string
data.endpoints_metadata.deleted_at
string
data.endpoints_metadata.description
string
data.endpoints_metadata.events
integer
data.endpoints_metadata.http_timeout
integer
data.endpoints_metadata.name
string
data.endpoints_metadata.owner_id
string
data.endpoints_metadata.project_id
string
data.endpoints_metadata.rate_limit
integer
data.endpoints_metadata.rate_limit_duration
integer
data.endpoints_metadata.secrets
object[]
data.endpoints_metadata.secrets.created_at
string
data.endpoints_metadata.secrets.deleted_at
string
data.endpoints_metadata.secrets.expires_at
string
data.endpoints_metadata.secrets.uid
string
data.endpoints_metadata.secrets.updated_at
string
data.endpoints_metadata.secrets.value
string
data.endpoints_metadata.slack_webhook_url
string
data.endpoints_metadata.status
enum<string>
Available options:
active
, inactive
, pending
, paused
data.endpoints_metadata.support_email
string
data.endpoints_metadata.uid
string
data.endpoints_metadata.updated_at
string
data.endpoints_metadata.url
string
data.name
string
data.owner_id
string
data.project_id
string
data.token
string
data.uid
string
data.updated_at
string
data.url
string
Was this page helpful?
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>"
}
}