List entities

GET

/entities

const url = 'https://shoehorn.example.com/api/v1/entities?limit=20&type=service&lifecycle=experimental&tier=tier1';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://shoehorn.example.com/api/v1/entities?limit=20&type=service&lifecycle=experimental&tier=tier1'

Returns a paginated list of catalog entities.

Parameters

Query Parameters

limit

integer

default: 20 <= 100

cursor

string

type

string

Allowed values: service library api website tool infrastructure platform mobile-app data-pipeline ml-model documentation

lifecycle

string

Allowed values: experimental development production deprecated

owner

string

tier

string

Allowed values: tier1 tier2 tier3 tier4

Responses

200

Paginated list of entities

application/json

object

entities

Array<object>

object

string format: uuid

service_id

Human-readable identifier

string

name

string

type

string

lifecycle

string

owner

string

description

string

tier

string

tags

Array<string>

links

Array<object>

object

title

string

url

string format: uri

icon

string

source

string

Allowed values: kubernetes manifest api github manual

created_at

string format: date-time

updated_at

string format: date-time

pagination

object

total

integer

page

integer

pageSize

integer

nextCursor

string

Example

{
  "entities": [
    {
      "source": "kubernetes"
    }
  ]
}