Update relationship type

curl --request PUT \
  --url https://api.getcortexapp.com/api/v1/relationship-types/{relationshipTypeTag} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allowCycles": false,
  "createCatalog": false,
  "definitionLocation": "BOTH",
  "destinationsFilter": {
    "include": true,
    "providers": [],
    "types": [
      "<string>"
    ]
  },
  "inheritances": [
    {
      "parameterTag": "<string>"
    }
  ],
  "isSingleDestination": false,
  "isSingleSource": false,
  "name": "Component Hierarchy",
  "sourcesFilter": {
    "include": true,
    "providers": [],
    "types": [
      "<string>"
    ]
  },
  "tag": "component-hierarchy",
  "description": "Defines the component hierarchy",
  "destinationLabelPlural": "Parts",
  "destinationLabelSingular": "Part",
  "sourceLabelPlural": "Components",
  "sourceLabelSingular": "Component"
}
'

import requests

url = "https://api.getcortexapp.com/api/v1/relationship-types/{relationshipTypeTag}"

payload = {
    "allowCycles": False,
    "createCatalog": False,
    "definitionLocation": "BOTH",
    "destinationsFilter": {
        "include": True,
        "providers": [],
        "types": ["<string>"]
    },
    "inheritances": [{ "parameterTag": "<string>" }],
    "isSingleDestination": False,
    "isSingleSource": False,
    "name": "Component Hierarchy",
    "sourcesFilter": {
        "include": True,
        "providers": [],
        "types": ["<string>"]
    },
    "tag": "component-hierarchy",
    "description": "Defines the component hierarchy",
    "destinationLabelPlural": "Parts",
    "destinationLabelSingular": "Part",
    "sourceLabelPlural": "Components",
    "sourceLabelSingular": "Component"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    allowCycles: false,
    createCatalog: false,
    definitionLocation: 'BOTH',
    destinationsFilter: {include: true, providers: [], types: ['<string>']},
    inheritances: [{parameterTag: '<string>'}],
    isSingleDestination: false,
    isSingleSource: false,
    name: 'Component Hierarchy',
    sourcesFilter: {include: true, providers: [], types: ['<string>']},
    tag: 'component-hierarchy',
    description: 'Defines the component hierarchy',
    destinationLabelPlural: 'Parts',
    destinationLabelSingular: 'Part',
    sourceLabelPlural: 'Components',
    sourceLabelSingular: 'Component'
  })
};

fetch('https://api.getcortexapp.com/api/v1/relationship-types/{relationshipTypeTag}', 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.getcortexapp.com/api/v1/relationship-types/{relationshipTypeTag}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'allowCycles' => false,
    'createCatalog' => false,
    'definitionLocation' => 'BOTH',
    'destinationsFilter' => [
        'include' => true,
        'providers' => [
                
        ],
        'types' => [
                '<string>'
        ]
    ],
    'inheritances' => [
        [
                'parameterTag' => '<string>'
        ]
    ],
    'isSingleDestination' => false,
    'isSingleSource' => false,
    'name' => 'Component Hierarchy',
    'sourcesFilter' => [
        'include' => true,
        'providers' => [
                
        ],
        'types' => [
                '<string>'
        ]
    ],
    'tag' => 'component-hierarchy',
    'description' => 'Defines the component hierarchy',
    'destinationLabelPlural' => 'Parts',
    'destinationLabelSingular' => 'Part',
    'sourceLabelPlural' => 'Components',
    'sourceLabelSingular' => 'Component'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.getcortexapp.com/api/v1/relationship-types/{relationshipTypeTag}"

	payload := strings.NewReader("{\n  \"allowCycles\": false,\n  \"createCatalog\": false,\n  \"definitionLocation\": \"BOTH\",\n  \"destinationsFilter\": {\n    \"include\": true,\n    \"providers\": [],\n    \"types\": [\n      \"<string>\"\n    ]\n  },\n  \"inheritances\": [\n    {\n      \"parameterTag\": \"<string>\"\n    }\n  ],\n  \"isSingleDestination\": false,\n  \"isSingleSource\": false,\n  \"name\": \"Component Hierarchy\",\n  \"sourcesFilter\": {\n    \"include\": true,\n    \"providers\": [],\n    \"types\": [\n      \"<string>\"\n    ]\n  },\n  \"tag\": \"component-hierarchy\",\n  \"description\": \"Defines the component hierarchy\",\n  \"destinationLabelPlural\": \"Parts\",\n  \"destinationLabelSingular\": \"Part\",\n  \"sourceLabelPlural\": \"Components\",\n  \"sourceLabelSingular\": \"Component\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.put("https://api.getcortexapp.com/api/v1/relationship-types/{relationshipTypeTag}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"allowCycles\": false,\n  \"createCatalog\": false,\n  \"definitionLocation\": \"BOTH\",\n  \"destinationsFilter\": {\n    \"include\": true,\n    \"providers\": [],\n    \"types\": [\n      \"<string>\"\n    ]\n  },\n  \"inheritances\": [\n    {\n      \"parameterTag\": \"<string>\"\n    }\n  ],\n  \"isSingleDestination\": false,\n  \"isSingleSource\": false,\n  \"name\": \"Component Hierarchy\",\n  \"sourcesFilter\": {\n    \"include\": true,\n    \"providers\": [],\n    \"types\": [\n      \"<string>\"\n    ]\n  },\n  \"tag\": \"component-hierarchy\",\n  \"description\": \"Defines the component hierarchy\",\n  \"destinationLabelPlural\": \"Parts\",\n  \"destinationLabelSingular\": \"Part\",\n  \"sourceLabelPlural\": \"Components\",\n  \"sourceLabelSingular\": \"Component\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcortexapp.com/api/v1/relationship-types/{relationshipTypeTag}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"allowCycles\": false,\n  \"createCatalog\": false,\n  \"definitionLocation\": \"BOTH\",\n  \"destinationsFilter\": {\n    \"include\": true,\n    \"providers\": [],\n    \"types\": [\n      \"<string>\"\n    ]\n  },\n  \"inheritances\": [\n    {\n      \"parameterTag\": \"<string>\"\n    }\n  ],\n  \"isSingleDestination\": false,\n  \"isSingleSource\": false,\n  \"name\": \"Component Hierarchy\",\n  \"sourcesFilter\": {\n    \"include\": true,\n    \"providers\": [],\n    \"types\": [\n      \"<string>\"\n    ]\n  },\n  \"tag\": \"component-hierarchy\",\n  \"description\": \"Defines the component hierarchy\",\n  \"destinationLabelPlural\": \"Parts\",\n  \"destinationLabelSingular\": \"Part\",\n  \"sourceLabelPlural\": \"Components\",\n  \"sourceLabelSingular\": \"Component\"\n}"

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

{
  "allowCycles": false,
  "definitionLocation": "BOTH",
  "destinationsFilter": {
    "include": true,
    "providers": [
      "AWS"
    ],
    "types": [
      "<string>"
    ]
  },
  "inheritances": [
    {
      "inheritanceType": "NONE",
      "parameterTag": "<string>"
    }
  ],
  "isCortexManaged": false,
  "isSingleDestination": false,
  "isSingleSource": false,
  "name": "Component Hierarchy",
  "sourcesFilter": {
    "include": true,
    "providers": [
      "AWS"
    ],
    "types": [
      "<string>"
    ]
  },
  "tag": "component-hierarchy",
  "description": "Defines the component hierarchy",
  "destinationLabelPlural": "Parts",
  "destinationLabelSingular": "Part",
  "destinationNamePlural": "<string>",
  "destinationNameSingular": "<string>",
  "sourceLabelPlural": "Components",
  "sourceLabelSingular": "Component",
  "sourceNamePlural": "<string>",
  "sourceNameSingular": "<string>"
}

{
  "message": "<string>",
  "type": "INTEGRATION_MISSING",
  "details": "<string>",
  "errorCode": "<string>",
  "gatewayHttpStatus": 123,
  "httpStatus": 123,
  "requestId": "<string>"
}

{
  "status": 429,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "retryAfter": 1
}

PUT

api

relationship-types

{relationshipTypeTag}

Update relationship type

curl --request PUT \
  --url https://api.getcortexapp.com/api/v1/relationship-types/{relationshipTypeTag} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allowCycles": false,
  "createCatalog": false,
  "definitionLocation": "BOTH",
  "destinationsFilter": {
    "include": true,
    "providers": [],
    "types": [
      "<string>"
    ]
  },
  "inheritances": [
    {
      "parameterTag": "<string>"
    }
  ],
  "isSingleDestination": false,
  "isSingleSource": false,
  "name": "Component Hierarchy",
  "sourcesFilter": {
    "include": true,
    "providers": [],
    "types": [
      "<string>"
    ]
  },
  "tag": "component-hierarchy",
  "description": "Defines the component hierarchy",
  "destinationLabelPlural": "Parts",
  "destinationLabelSingular": "Part",
  "sourceLabelPlural": "Components",
  "sourceLabelSingular": "Component"
}
'

import requests

url = "https://api.getcortexapp.com/api/v1/relationship-types/{relationshipTypeTag}"

payload = {
    "allowCycles": False,
    "createCatalog": False,
    "definitionLocation": "BOTH",
    "destinationsFilter": {
        "include": True,
        "providers": [],
        "types": ["<string>"]
    },
    "inheritances": [{ "parameterTag": "<string>" }],
    "isSingleDestination": False,
    "isSingleSource": False,
    "name": "Component Hierarchy",
    "sourcesFilter": {
        "include": True,
        "providers": [],
        "types": ["<string>"]
    },
    "tag": "component-hierarchy",
    "description": "Defines the component hierarchy",
    "destinationLabelPlural": "Parts",
    "destinationLabelSingular": "Part",
    "sourceLabelPlural": "Components",
    "sourceLabelSingular": "Component"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    allowCycles: false,
    createCatalog: false,
    definitionLocation: 'BOTH',
    destinationsFilter: {include: true, providers: [], types: ['<string>']},
    inheritances: [{parameterTag: '<string>'}],
    isSingleDestination: false,
    isSingleSource: false,
    name: 'Component Hierarchy',
    sourcesFilter: {include: true, providers: [], types: ['<string>']},
    tag: 'component-hierarchy',
    description: 'Defines the component hierarchy',
    destinationLabelPlural: 'Parts',
    destinationLabelSingular: 'Part',
    sourceLabelPlural: 'Components',
    sourceLabelSingular: 'Component'
  })
};

fetch('https://api.getcortexapp.com/api/v1/relationship-types/{relationshipTypeTag}', 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.getcortexapp.com/api/v1/relationship-types/{relationshipTypeTag}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'allowCycles' => false,
    'createCatalog' => false,
    'definitionLocation' => 'BOTH',
    'destinationsFilter' => [
        'include' => true,
        'providers' => [
                
        ],
        'types' => [
                '<string>'
        ]
    ],
    'inheritances' => [
        [
                'parameterTag' => '<string>'
        ]
    ],
    'isSingleDestination' => false,
    'isSingleSource' => false,
    'name' => 'Component Hierarchy',
    'sourcesFilter' => [
        'include' => true,
        'providers' => [
                
        ],
        'types' => [
                '<string>'
        ]
    ],
    'tag' => 'component-hierarchy',
    'description' => 'Defines the component hierarchy',
    'destinationLabelPlural' => 'Parts',
    'destinationLabelSingular' => 'Part',
    'sourceLabelPlural' => 'Components',
    'sourceLabelSingular' => 'Component'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.getcortexapp.com/api/v1/relationship-types/{relationshipTypeTag}"

	payload := strings.NewReader("{\n  \"allowCycles\": false,\n  \"createCatalog\": false,\n  \"definitionLocation\": \"BOTH\",\n  \"destinationsFilter\": {\n    \"include\": true,\n    \"providers\": [],\n    \"types\": [\n      \"<string>\"\n    ]\n  },\n  \"inheritances\": [\n    {\n      \"parameterTag\": \"<string>\"\n    }\n  ],\n  \"isSingleDestination\": false,\n  \"isSingleSource\": false,\n  \"name\": \"Component Hierarchy\",\n  \"sourcesFilter\": {\n    \"include\": true,\n    \"providers\": [],\n    \"types\": [\n      \"<string>\"\n    ]\n  },\n  \"tag\": \"component-hierarchy\",\n  \"description\": \"Defines the component hierarchy\",\n  \"destinationLabelPlural\": \"Parts\",\n  \"destinationLabelSingular\": \"Part\",\n  \"sourceLabelPlural\": \"Components\",\n  \"sourceLabelSingular\": \"Component\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.put("https://api.getcortexapp.com/api/v1/relationship-types/{relationshipTypeTag}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"allowCycles\": false,\n  \"createCatalog\": false,\n  \"definitionLocation\": \"BOTH\",\n  \"destinationsFilter\": {\n    \"include\": true,\n    \"providers\": [],\n    \"types\": [\n      \"<string>\"\n    ]\n  },\n  \"inheritances\": [\n    {\n      \"parameterTag\": \"<string>\"\n    }\n  ],\n  \"isSingleDestination\": false,\n  \"isSingleSource\": false,\n  \"name\": \"Component Hierarchy\",\n  \"sourcesFilter\": {\n    \"include\": true,\n    \"providers\": [],\n    \"types\": [\n      \"<string>\"\n    ]\n  },\n  \"tag\": \"component-hierarchy\",\n  \"description\": \"Defines the component hierarchy\",\n  \"destinationLabelPlural\": \"Parts\",\n  \"destinationLabelSingular\": \"Part\",\n  \"sourceLabelPlural\": \"Components\",\n  \"sourceLabelSingular\": \"Component\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcortexapp.com/api/v1/relationship-types/{relationshipTypeTag}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"allowCycles\": false,\n  \"createCatalog\": false,\n  \"definitionLocation\": \"BOTH\",\n  \"destinationsFilter\": {\n    \"include\": true,\n    \"providers\": [],\n    \"types\": [\n      \"<string>\"\n    ]\n  },\n  \"inheritances\": [\n    {\n      \"parameterTag\": \"<string>\"\n    }\n  ],\n  \"isSingleDestination\": false,\n  \"isSingleSource\": false,\n  \"name\": \"Component Hierarchy\",\n  \"sourcesFilter\": {\n    \"include\": true,\n    \"providers\": [],\n    \"types\": [\n      \"<string>\"\n    ]\n  },\n  \"tag\": \"component-hierarchy\",\n  \"description\": \"Defines the component hierarchy\",\n  \"destinationLabelPlural\": \"Parts\",\n  \"destinationLabelSingular\": \"Part\",\n  \"sourceLabelPlural\": \"Components\",\n  \"sourceLabelSingular\": \"Component\"\n}"

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

{
  "allowCycles": false,
  "definitionLocation": "BOTH",
  "destinationsFilter": {
    "include": true,
    "providers": [
      "AWS"
    ],
    "types": [
      "<string>"
    ]
  },
  "inheritances": [
    {
      "inheritanceType": "NONE",
      "parameterTag": "<string>"
    }
  ],
  "isCortexManaged": false,
  "isSingleDestination": false,
  "isSingleSource": false,
  "name": "Component Hierarchy",
  "sourcesFilter": {
    "include": true,
    "providers": [
      "AWS"
    ],
    "types": [
      "<string>"
    ]
  },
  "tag": "component-hierarchy",
  "description": "Defines the component hierarchy",
  "destinationLabelPlural": "Parts",
  "destinationLabelSingular": "Part",
  "destinationNamePlural": "<string>",
  "destinationNameSingular": "<string>",
  "sourceLabelPlural": "Components",
  "sourceLabelSingular": "Component",
  "sourceNamePlural": "<string>",
  "sourceNameSingular": "<string>"
}

{
  "message": "<string>",
  "type": "INTEGRATION_MISSING",
  "details": "<string>",
  "errorCode": "<string>",
  "gatewayHttpStatus": 123,
  "httpStatus": 123,
  "requestId": "<string>"
}

{
  "status": 429,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "retryAfter": 1
}

Authorizations

Authorization

string

header

required

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path Parameters

relationshipTypeTag

string

required

Body

application/json

Request to create or update a relationship type

allowCycles

boolean

required

Whether cyclical relationships are allowed

Example:

false

createCatalog

boolean

required

Whether to create a catalog page for this relationship type

Example:

false

definitionLocation

enum<string>

required

Defines where a relationship can be configured in entity descriptors

Available options:

SOURCE,

DESTINATION,

BOTH

Example:

"BOTH"

destinationsFilter

object

required

Show child attributes

inheritances

object[]

required

Inheritance configuration for Cortex parameters. Currently supports ownership inheritance via x-cortex-owners.

Show child attributes

isSingleDestination

boolean

required

Whether an entity can have only one destination for this relationship type

Example:

false

isSingleSource

boolean

required

Whether an entity can have only one source for this relationship type

Example:

false

name

string

required

Human-readable name for the relationship type

Example:

"Component Hierarchy"

sourcesFilter

object

required

Show child attributes

tag

string

required

Unique identifier tag for the relationship type

Example:

"component-hierarchy"

description

string

Optional description explaining the relationship type

Example:

"Defines the component hierarchy"

destinationLabelPlural

string

Plural label for destinations in the relationship

Example:

"Parts"

destinationLabelSingular

string

Singular label for destinations in the relationship

Example:

"Part"

sourceLabelPlural

string

Plural label for sources in the relationship

Example:

"Components"

sourceLabelSingular

string

Singular label for sources in the relationship

Example:

"Component"

Response

Successfully updated relationship type

Response containing relationship type details

allowCycles

boolean

required

Whether cyclical relationships are allowed

Example:

false

definitionLocation

enum<string>

required

Defines where a relationship can be configured in entity descriptors

Available options:

SOURCE,

DESTINATION,

BOTH

Example:

"BOTH"

destinationsFilter

object

required

Show child attributes

inheritances

object[]

required

Inheritance configuration for Cortex parameters. Currently supports ownership inheritance via x-cortex-owners.

Show child attributes

isCortexManaged

boolean

required

Whether this relationship type is managed by Cortex

Example:

false

isSingleDestination

boolean

required

Whether an entity can have only one destination for this relationship type

Example:

false

isSingleSource

boolean

required

Whether an entity can have only one source for this relationship type

Example:

false

name

string

required

Human-readable name for the relationship type

Example:

"Component Hierarchy"

sourcesFilter

object

required

Show child attributes

tag

string

required

Unique identifier tag for the relationship type

Example:

"component-hierarchy"

description

string

Optional description explaining the relationship type

Example:

"Defines the component hierarchy"

destinationLabelPlural

string

Plural label for destinations in the relationship

Example:

"Parts"

destinationLabelSingular

string

Singular label for destinations in the relationship

Example:

"Part"

destinationNamePlural

string

destinationNameSingular

string

sourceLabelPlural

string

Plural label for sources in the relationship

Example:

"Components"

sourceLabelSingular

string

Singular label for sources in the relationship

Example:

"Component"

sourceNamePlural

string

sourceNameSingular

string

Last modified on September 24, 2026

Get started

REST API operations

Update relationship type

Authorizations

Path Parameters

Body

Response