Portal Links
Create a portal link
Portal Links
Create a portal link
This endpoint creates a portal link
POST
/
v1
/
projects
/
{projectID}
/
portal-links
curl --request POST \
--url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/portal-links \
--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,
"failure_rate": 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
Path Parameters
Project ID
Body
application/json
Portal Link Details
Specify whether endpoint management can be done through the Portal Link UI
IDs of endpoints in this portal link
Portal Link Name
Alternatively specify OwnerID, the portal link will inherit all the endpoints with this owner ID
Response
201
application/json
Created
Available options:
active
, inactive
, pending
, paused
Was this page helpful?
curl --request POST \
--url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/portal-links \
--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,
"failure_rate": 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>"
}
}