Skip to main content
POST
/
v1
/
projects
/
{projectID}
/
portal-links
Create a portal link
curl --request POST \
  --url https://us.getconvoy.cloud/api/v1/projects/{projectID}/portal-links \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "auth_type": "<string>",
  "can_manage_endpoint": true,
  "endpoints": [
    "<string>"
  ],
  "name": "<string>",
  "owner_id": "<string>"
}
'
import requests

url = "https://us.getconvoy.cloud/api/v1/projects/{projectID}/portal-links"

payload = {
"auth_type": "<string>",
"can_manage_endpoint": True,
"endpoints": ["<string>"],
"name": "<string>",
"owner_id": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
auth_type: '<string>',
can_manage_endpoint: true,
endpoints: ['<string>'],
name: '<string>',
owner_id: '<string>'
})
};

fetch('https://us.getconvoy.cloud/api/v1/projects/{projectID}/portal-links', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://us.getconvoy.cloud/api/v1/projects/{projectID}/portal-links",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'auth_type' => '<string>',
'can_manage_endpoint' => true,
'endpoints' => [
'<string>'
],
'name' => '<string>',
'owner_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://us.getconvoy.cloud/api/v1/projects/{projectID}/portal-links"

payload := strings.NewReader("{\n \"auth_type\": \"<string>\",\n \"can_manage_endpoint\": true,\n \"endpoints\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"owner_id\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://us.getconvoy.cloud/api/v1/projects/{projectID}/portal-links")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"auth_type\": \"<string>\",\n \"can_manage_endpoint\": true,\n \"endpoints\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"owner_id\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://us.getconvoy.cloud/api/v1/projects/{projectID}/portal-links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"auth_type\": \"<string>\",\n \"can_manage_endpoint\": true,\n \"endpoints\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"owner_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "message": "<string>",
  "status": true,
  "data": {
    "auth_key": "<string>",
    "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>"
          },
          "basic_auth": {
            "password": "<string>",
            "username": "<string>"
          },
          "oauth2": {
            "audience": "<string>",
            "client_id": "<string>",
            "client_secret": "<string>",
            "field_mapping": {
              "access_token": "<string>",
              "expires_in": "<string>",
              "token_type": "<string>"
            },
            "grant_type": "<string>",
            "issuer": "<string>",
            "scope": "<string>",
            "signing_algorithm": "<string>",
            "signing_key": {
              "crv": "<string>",
              "d": "<string>",
              "dp": "<string>",
              "dq": "<string>",
              "e": "<string>",
              "kid": "<string>",
              "kty": "<string>",
              "n": "<string>",
              "p": "<string>",
              "q": "<string>",
              "qi": "<string>",
              "x": "<string>",
              "y": "<string>"
            },
            "subject": "<string>",
            "url": "<string>"
          }
        },
        "content_type": "<string>",
        "created_at": "<string>",
        "deleted_at": "<string>",
        "description": "<string>",
        "events": 123,
        "failure_rate": 123,
        "http_timeout": 123,
        "mtls_client_cert": {
          "client_cert": "<string>",
          "client_key": "<string>"
        },
        "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>",
        "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>"
  }
}
{
"message": "<string>",
"status": true,
"data": {}
}
{
"message": "<string>",
"status": true,
"data": {}
}
{
"message": "<string>",
"status": true,
"data": {}
}

Authorizations

Authorization
string
header
required

Path Parameters

projectID
string
required

Project ID

Body

application/json

Portal Link Details

auth_type
string
can_manage_endpoint
boolean

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

endpoints
string[]

Deprecated IDs of endpoints in this portal link

name
string

Portal Link Name

owner_id
string

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

Response

Created

message
string
status
boolean
data
object