Skip to content
FractalOps

Get Domain Shell

GET
/v1/portal/lineage/domains/{domain_id}
curl --request GET \
  --url 'https://example.com/v1/portal/lineage/domains/example?limit=12&tenant_id='

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
domain_id
required
Domain Id
string

Query Parameters

Section titled “Query Parameters”
limit
Limit
integer
default: 12 >= 1 <= 50
tenant_id
Tenant Id
string
""

Header Parameters

Section titled “Header Parameters”
X-FractalOps-Tenant-Id
Any of:
string
x-pomerium-jwt-assertion
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
PortalDomainShellOut
object
domain_id
required
Domain Id
string
title
required
Title
string
summary
Summary
string
""
status
Status
string
default: active
entity_count
Entity Count
integer
0
urgent_count
Urgent Count
integer
0
key_entities
Key Entities
Array<object>
PortalGraphItemOut
object
item_key
required
Item Key
string
title
required
Title
string
summary
Summary
string
""
status
Status
string
""
href
Href
string
""
chips
Chips
Array<string>
metric_label
Metric Label
string
""
metric_value
Metric Value
integer
0
actions
Actions
Array<object>
PortalGraphActionOut
object
action_id
required
Action Id
string
label
required
Label
string
url
required
Url
string
kind
Kind
string
default: open
summary
Summary
string
""
status
Status
string
""
entity_kind
Entity Kind
string
""
entity_key
Entity Key
string
""
domain_actions
Domain Actions
Array<object>
PortalGraphActionOut
object
action_id
required
Action Id
string
label
required
Label
string
url
required
Url
string
kind
Kind
string
default: open
summary
Summary
string
""
status
Status
string
""
entity_kind
Entity Kind
string
""
entity_key
Entity Key
string
""
recent_changes
Recent Changes
Array<string>
empty_state
Empty State
string
""
Example
{
  "summary": "",
  "status": "active",
  "entity_count": 0,
  "urgent_count": 0,
  "key_entities": [
    {
      "summary": "",
      "status": "",
      "href": "",
      "metric_label": "",
      "metric_value": 0,
      "actions": [
        {
          "kind": "open",
          "summary": "",
          "status": "",
          "entity_kind": "",
          "entity_key": ""
        }
      ]
    }
  ],
  "domain_actions": [
    {
      "kind": "open",
      "summary": "",
      "status": "",
      "entity_kind": "",
      "entity_key": ""
    }
  ],
  "empty_state": ""
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}