Link To Registry

POST /link_to_registry

Link To Registry

cURL

curl --request POST \
  --url https://api.example.com/link_to_registry \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ref": "<string>",
  "target": {
    "portfolio_name": "<string>",
    "entity_name": "<string>",
    "project_name": "<string>"
  },
  "aliases": []
}
'

import requests

url = "https://api.example.com/link_to_registry"

payload = {
    "ref": "<string>",
    "target": {
        "portfolio_name": "<string>",
        "entity_name": "<string>",
        "project_name": "<string>"
    },
    "aliases": []
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ref: '<string>',
    target: {portfolio_name: '<string>', entity_name: '<string>', project_name: '<string>'},
    aliases: []
  })
};

fetch('https://api.example.com/link_to_registry', 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://api.example.com/link_to_registry",
  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([
    'ref' => '<string>',
    'target' => [
        'portfolio_name' => '<string>',
        'entity_name' => '<string>',
        'project_name' => '<string>'
    ],
    'aliases' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "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://api.example.com/link_to_registry"

	payload := strings.NewReader("{\n  \"ref\": \"<string>\",\n  \"target\": {\n    \"portfolio_name\": \"<string>\",\n    \"entity_name\": \"<string>\",\n    \"project_name\": \"<string>\"\n  },\n  \"aliases\": []\n}")

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

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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://api.example.com/link_to_registry")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ref\": \"<string>\",\n  \"target\": {\n    \"portfolio_name\": \"<string>\",\n    \"entity_name\": \"<string>\",\n    \"project_name\": \"<string>\"\n  },\n  \"aliases\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/link_to_registry")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ref\": \"<string>\",\n  \"target\": {\n    \"portfolio_name\": \"<string>\",\n    \"entity_name\": \"<string>\",\n    \"project_name\": \"<string>\"\n  },\n  \"aliases\": []\n}"

response = http.request(request)
puts response.read_body

200

{
  "version_index": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

ref · string · required

Minimum string length: 1

target · CreateAndLinkTarget · object · required

Show child attributes

aliases · string[]

Response

200

application/json

Successful Response

version_index · integer | null