Bulk upsert Catalog Entities

Create or update multiple catalog entities by external_id. Only attributes present in the payload are written (managed-fields semantics). Transactional: all succeed or all fail.

POST /v1/catalogs/{catalog_id}/entities/bulk_upsert

Bulk upsert Catalog Entities

cURL

curl --request POST \
  --url https://api.rootly.com/v1/catalogs/{catalog_id}/entities/bulk_upsert \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "entities": [
    {
      "external_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "backstage_id": "<string>",
      "fields": [
        {
          "value": "<string>",
          "catalog_field_id": "<string>",
          "catalog_property_id": "<string>"
        }
      ]
    }
  ]
}
'

import requests

url = "https://api.rootly.com/v1/catalogs/{catalog_id}/entities/bulk_upsert"

payload = { "entities": [
        {
            "external_id": "<string>",
            "name": "<string>",
            "description": "<string>",
            "backstage_id": "<string>",
            "fields": [
                {
                    "value": "<string>",
                    "catalog_field_id": "<string>",
                    "catalog_property_id": "<string>"
                }
            ]
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/vnd.api+json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
  body: JSON.stringify({
    entities: [
      {
        external_id: '<string>',
        name: '<string>',
        description: '<string>',
        backstage_id: '<string>',
        fields: [
          {
            value: '<string>',
            catalog_field_id: '<string>',
            catalog_property_id: '<string>'
          }
        ]
      }
    ]
  })
};

fetch('https://api.rootly.com/v1/catalogs/{catalog_id}/entities/bulk_upsert', 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.rootly.com/v1/catalogs/{catalog_id}/entities/bulk_upsert",
  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([
    'entities' => [
        [
                'external_id' => '<string>',
                'name' => '<string>',
                'description' => '<string>',
                'backstage_id' => '<string>',
                'fields' => [
                                [
                                                                'value' => '<string>',
                                                                'catalog_field_id' => '<string>',
                                                                'catalog_property_id' => '<string>'
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/vnd.api+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.rootly.com/v1/catalogs/{catalog_id}/entities/bulk_upsert"

	payload := strings.NewReader("{\n  \"entities\": [\n    {\n      \"external_id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"backstage_id\": \"<string>\",\n      \"fields\": [\n        {\n          \"value\": \"<string>\",\n          \"catalog_field_id\": \"<string>\",\n          \"catalog_property_id\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/vnd.api+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.rootly.com/v1/catalogs/{catalog_id}/entities/bulk_upsert")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/vnd.api+json")
  .body("{\n  \"entities\": [\n    {\n      \"external_id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"backstage_id\": \"<string>\",\n      \"fields\": [\n        {\n          \"value\": \"<string>\",\n          \"catalog_field_id\": \"<string>\",\n          \"catalog_property_id\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.rootly.com/v1/catalogs/{catalog_id}/entities/bulk_upsert")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n  \"entities\": [\n    {\n      \"external_id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"backstage_id\": \"<string>\",\n      \"fields\": [\n        {\n          \"value\": \"<string>\",\n          \"catalog_field_id\": \"<string>\",\n          \"catalog_property_id\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}"

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

200

{
  "data": [
    {
      "id": "<string>",
      "type": "catalog_entities",
      "attributes": {
        "name": "<string>",
        "position": 123,
        "created_at": "<string>",
        "updated_at": "<string>",
        "description": "<string>",
        "backstage_id": "<string>",
        "external_id": "<string>",
        "properties": [
          {
            "catalog_property_id": "<string>",
            "value": "<string>"
          }
        ]
      }
    }
  ]
}

{
  "errors": [
    {
      "title": "<string>",
      "status": "<string>",
      "code": "<string>",
      "detail": "<string>"
    }
  ]
}

{
  "errors": [
    {
      "title": "<string>",
      "status": "<string>",
      "code": "<string>",
      "detail": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

catalog_id · string · required

Body

application/vnd.api+json

entities · object[] · required

Array of catalog entities to upsert. Each must have an external_id. Max 100 per request. external_ids must be unique within a batch.

Show child attributes

Response

200

application/vnd.api+json

entities upserted successfully

data · object[]

Show child attributes