The Pages API from Port — 6 operation(s) for pages.
openapi: 3.1.0
info:
title: Port Action Runs Pages API
version: '1.0'
tags:
- name: Pages
paths:
/v1/pages/{page_identifier}/permissions:
get:
summary: Get a page's permissions
tags:
- Pages
description: This route allows you to get a specific page's permissions.<br/><br/>To learn more about pages, check out the [documentation](https://docs.port.io/customize-pages-dashboards-and-plugins/page/page-permissions).
parameters:
- schema:
type: string
minLength: 1
in: path
name: page_identifier
required: true
security:
- bearer: []
responses:
'401':
description: Default Response
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
'404':
description: A resource with the provided identifier was not found
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: A resource with the provided identifier was not found
patch:
summary: Update a page's permissions
tags:
- Pages
description: This route allows you to update a specific page’s permissions. <br/><br/>To learn more about pages, check out the [documentation](https://docs.port.io/customize-pages-dashboards-and-plugins/page/page-permissions).
requestBody:
content:
application/json:
schema:
type: object
properties:
read:
type: object
properties:
users:
type: array
items:
type: string
roles:
type: array
items:
type: string
teams:
type: array
items:
type: string
additionalProperties: false
update:
type: object
properties:
users:
type: array
items:
type: string
roles:
type: array
items:
type: string
teams:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
parameters:
- schema:
type: string
minLength: 1
in: path
name: page_identifier
required: true
security:
- bearer: []
responses:
'401':
description: Default Response
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
'404':
description: A resource with the provided identifier was not found
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: A resource with the provided identifier was not found
'413':
description: Request body is too large (limit is 1MiB)
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
description: Request body is too large (limit is 1MiB)
'422':
description: The json provided does not match the route's schema
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: The json provided does not match the route's schema
/v1/pages:
get:
summary: Get all pages in your portal
tags:
- Pages
description: This route allows you to get all pages in your portal.<br/><br/>To learn more about pages, checkout the [documentation](https://docs.port.io/customize-pages-dashboards-and-plugins/page/catalog-page).
parameters:
- schema:
type: boolean
default: false
in: query
name: compact
required: true
security:
- bearer: []
responses:
'401':
description: Default Response
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
additionalProperties: false
'404':
description: A resource with the provided identifier was not found
content:
application/json:
schema:
properties:
ok:
const: false
error:
type: string
message:
type: string
required:
- ok
- error
- message
additionalProperties: false
description: A resource with the provided identifier was not found
post:
summary: Create pages in your portal
tags:
- Pages
description: This route allows you to create pages in your portal.<br/><br/>To learn more about pages, checkout the [documentation](https://docs.port.io/customize-pages-dashboards-and-plugins/page/catalog-page).
requestBody:
content:
application/json:
schema:
type: object
properties:
identifier:
type: string
pattern: ^(?!\.{1,2}$)(?:[A-Za-z0-9@_.:\/=\-]|\$team\b|\$users\b|\$user\b|\$AuditLog\b|\$run\b|\$RunsHistory\b|\$home)*$
minLength: 1
example: string
blueprint:
type: string
title:
type: string
description:
type: string
icon:
type: string
sidebar:
type: string
nullable: true
enum:
- null
- catalog
parent:
type: string
nullable: true
after:
type: string
nullable: true
locked:
type: boolean
requiredQueryParams:
type: array
items:
type: string
widgets:
type: array
items:
type: object
anyOf:
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- ai-agent
title:
type: string
description:
type: string
agentIdentifier:
type: string
icon:
type: string
useMCP:
type: boolean
additionalProperties: false
required:
- type
- agentIdentifier
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- entity-info
title:
type: string
description:
type: string
icon:
type: string
entity:
type: string
hiddenQuery:
type: array
items:
type: string
order:
type: array
items:
type: string
showEmptyValues:
type: boolean
blueprint:
type: string
additionalProperties: false
required:
- type
- entity
- blueprint
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- entity-details
title:
type: string
description:
type: string
icon:
type: string
entity:
type: string
hiddenQuery:
type: array
items:
type: string
order:
type: array
items:
type: string
showEmptyValues:
type: boolean
blueprint:
type: string
additionalProperties: false
required:
- type
- entity
- blueprint
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- action-runs-table-widget
icon:
type: string
description:
type: string
title:
type: string
displayMode:
type: string
enum:
- single
- widget
action:
type: string
tableConfig:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
additionalProperties: false
additionalProperties: false
required:
- type
- action
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- action-card-widget
icon:
type: string
description:
type: string
title:
type: string
actions:
type: array
items:
type: object
properties:
action:
type: string
required:
- action
minItems: 1
additionalProperties: false
required:
- type
- actions
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- links-widget
title:
type: string
description:
type: string
icon:
type: string
links:
type: array
items:
type: object
properties:
title:
type: string
minLength: 1
description:
type: string
url:
type: string
icon:
type: string
additionalProperties: false
required:
- title
- url
additionalProperties: false
required:
- type
- links
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-entities-explorer
icon:
type: string
description:
type: string
emptyStateText:
type: string
title:
type: string
blueprint:
type: string
dataset:
$ref: '#/components/schemas/def-1'
excludedFields:
type: array
items:
type: string
displayMode:
type: string
enum:
- tabs
- single
- widget
entitiesQueryMode:
type: string
enum:
- standard
- optimized
blueprintConfig:
type: object
propertyNames:
pattern: ^(?!\.{1,2}$)[\p{L}0-9@_.+:\\/='-]+$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- dataset
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-entities-explorer-by-direction
title:
type: string
blueprintConfig:
type: object
propertyNames:
pattern: ^[A-Za-z0-9@_.:\\/=-]*\$(specificpath|upstream|downstream|custom)(\$[A-Za-z0-9@_.:\\/=-]+)*$
additionalProperties:
type: object
properties:
filterSettings:
type: object
properties:
filterBy:
$ref: '#/components/schemas/def-1'
additionalProperties: false
required:
- filterBy
groupSettings:
type: object
properties:
groupBy:
type: array
items:
type: string
additionalProperties: false
required:
- groupBy
sortSettings:
type: object
properties:
sortBy:
type: array
items:
type: object
properties:
property:
type: string
order:
enum:
- asc
- desc
additionalProperties: false
required:
- property
- order
additionalProperties: false
propertiesSettings:
type: object
properties:
hidden:
type: array
items:
type: string
shown:
type: array
items:
type: string
order:
type: array
items:
type: string
additionalProperties: false
tabIndex:
type: number
hidden:
type: boolean
title:
type: string
maxLength: 20
description:
type: string
dataset:
$ref: '#/components/schemas/def-1'
targetBlueprint:
type: string
relatedProperty:
type: string
additionalProperties: false
additionalProperties: false
required:
- type
- type: object
properties:
id:
type: string
updatedAt:
type: string
updatedBy:
type: string
createdAt:
type: string
createdBy:
type: string
type:
enum:
- table-audit-log
title:
type: string
description:
type: string
query:
type: object
properties:
identifier:
type: string
description: An identifier of the log event you want to fetch.
entity:
type: string
description: Fetch all audit logs related to the specified entity.
include_deleted_entities:
type: boolean
description: Include deleted entities when searching for audit logs. This requires the `entity`, `blueprint`, `status`, `from` and `to` parameters. And the diff between `from` & `to` is limited to 1 day.
blueprint:
type: string
description: Fetch all audit logs related to the specified blueprint.
run_id:
type: string
description: Fetch all audit logs related to the specified action run.
webhookId:
type: string
description: Fetch all audit logs related to the specified webhook.
webhookEventId:
type: string
description: Fetch all audit logs related to the specified webhook event.
origin:
type: array
items:
type: string
description: Fetch all audit logs coming from the specified origin/s. This refers to the integration/s that triggered the log. For operations performed via Port's UI, the origin will be `UI`.
InstallationId:
type: string
description: Fetch all audit logs related to the specified integration.
resources:
anyOf:
- type: array
items:
type: string
enum:
- entity
- blueprint_permission
- blueprint
- run
- webhook
- action
- action_permission
- scorecard
- integration
- secret
- type: string
enum:
- entity
- blueprint_permission
- blueprint
- run
- webhook
- action
- action_permission
- scorecard
- integration
- secret
description: 'Fetch all audit logs related to the specified resource type/s.<br/>**Possible values**: [`blueprint`, `entity`, `run`, `webhook`, `scorecard`, `action`, `integration`]<br/>The `integration` value is **experimental** and may
# --- truncated at 32 KB (1776 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/port/refs/heads/main/openapi/port-pages-api-openapi.yml