List Catalog Entities

List Catalog Entities

GET /v1/catalogs/{catalog_id}/entities

List Catalog Entities

cURL

curl --request GET \
  --url https://api.rootly.com/v1/catalogs/{catalog_id}/entities \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.rootly.com/v1/catalogs/{catalog_id}/entities', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.rootly.com/v1/catalogs/{catalog_id}/entities")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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>"
          }
        ]
      }
    }
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "prev": "<string>",
    "next": "<string>",
    "last": "<string>"
  },
  "meta": {
    "current_page": 123,
    "next_page": 123,
    "prev_page": 123,
    "total_count": 123,
    "total_pages": 123,
    "next_cursor": "<string>"
  },
  "included": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {},
      "relationships": {}
    }
  ]
}

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

Query Parameters

include · enum<string>

comma separated if needed. eg: catalog,properties

Available options: catalog, properties

sort · enum<string>

comma separated if needed. eg: created_at,updated_at

Available options: created_at, -created_at, updated_at, -updated_at, position, -position

page[number] · integer

page[size] · integer

filter[search] · string

filter[slug] · string

filter[name] · string

filter[backstage_id] · string

filter[external_id] · string

filter[managed_by] · string

filter[created_at][gt] · string

filter[created_at][gte] · string

filter[created_at][lt] · string

filter[created_at][lte] · string

filter[slug][eq] · string

filter[slug][not_eq] · string

filter[slug][in] · string

filter[slug][not_in] · string

filter[name][eq] · string

filter[name][not_eq] · string

filter[name][in] · string

filter[name][not_in] · string

filter[managed_by][eq] · string

filter[managed_by][not_eq] · string

filter[managed_by][in] · string

filter[managed_by][not_in] · string

Response

200 - application/vnd.api+json

success

data · object[] · required

Show child attributes

links · object · required

Show child attributes

meta · object · required

Show child attributes

included · object[]

Show child attributes