Skip to content
FractalOps

Get Canvas

GET
/v1/admin/policy-canvas/{canvas_key}
curl --request GET \
  --url 'https://example.com/v1/admin/policy-canvas/example?tenant_id='

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
canvas_key
required
Canvas Key
string

Query Parameters

Section titled “Query Parameters”
tenant_id
Tenant Id
string
""

Header Parameters

Section titled “Header Parameters”
x-pomerium-jwt-assertion
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
PolicyCanvasOut
object
tenant_id
required
Tenant Id
string
canvas_key
required
Canvas Key
string
name
required
Name
string
graph
Graph
object
key
additional properties
any
metadata
Metadata
object
key
additional properties
any
created_by
required
Created By
string
updated_by
required
Updated By
string
created_at
required
Created At
string
updated_at
required
Updated At
string
Examplegenerated
{
  "tenant_id": "example",
  "canvas_key": "example",
  "name": "example",
  "graph": {},
  "metadata": {},
  "created_by": "example",
  "updated_by": "example",
  "created_at": "example",
  "updated_at": "example"
}

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": {}
    }
  ]
}