Portal Links
Retrieve a portal link
Portal Links
Retrieve a portal link
This endpoint retrieves a portal link by its id.
GET
/
v1
/
projects
/
{projectID}
/
portal-links
/
{portalLinkID}
curl --request GET \
--url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/portal-links/{portalLinkID} \
--header 'Authorization: <api-key>'
{
"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
Response
200
application/json
OK
Available options:
active
, inactive
, pending
, paused
Was this page helpful?
curl --request GET \
--url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/portal-links/{portalLinkID} \
--header 'Authorization: <api-key>'
{
"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>"
}
}