Skip to main content

๐Ÿงช API Reference

This page includes all of the API endpoints available in Port.

Here you can learn how to interact with different Port components: blueprints, entities, relations, actions and more

Port API (1.0)

Download OpenAPI specification:Download

Actions

/v1/blueprints/{blueprint_identifier}/actions/{action_identifier}/permissions

Authorizations:
bearer
path Parameters
action_identifier
required
string
blueprint_identifier
required
string

Responses

/v1/blueprints/{blueprint_identifier}/actions/{action_identifier}/permissions

Authorizations:
bearer
path Parameters
action_identifier
required
string
blueprint_identifier
required
string
Request Body schema: application/json
object
object

Responses

Request samples

Content type
application/json
{
  • "execute": {
    },
  • "approve": {
    }
}

/v1/blueprints/{blueprint_identifier}/actions

Authorizations:
bearer
path Parameters
blueprint_identifier
required
string
Request Body schema: application/json
identifier
required
string^[A-Za-z0-9@_\\.\\=-]*$
title
string
icon
string
description
string
trigger
required
string
Enum: "CREATE" "DELETE" "DAY-2"
requiredApproval
boolean
required
object or object or object or object
required
object

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "title": "string",
  • "icon": "string",
  • "description": "string",
  • "trigger": "CREATE",
  • "requiredApproval": true,
  • "invocationMethod": {
    },
  • "userInputs": {
    }
}

/v1/blueprints/{blueprint_identifier}/actions

Authorizations:
bearer
path Parameters
blueprint_identifier
required
string
Request Body schema: application/json
Array
identifier
required
string^[A-Za-z0-9@_\\.\\=-]*$
title
string
icon
string
description
string
trigger
required
string
Enum: "CREATE" "DELETE" "DAY-2"
requiredApproval
boolean
required
object or object or object or object
required
object
id
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

/v1/blueprints/{blueprint_identifier}/actions

Authorizations:
bearer
path Parameters
blueprint_identifier
required
string

Responses

/v1/blueprints/{blueprint_identifier}/actions/{action_identifier}

Authorizations:
bearer
path Parameters
action_identifier
required
string
blueprint_identifier
required
string
Request Body schema: application/json
identifier
required
string^[A-Za-z0-9@_\\.\\=-]*$
title
string
icon
string
description
string
trigger
required
string
Enum: "CREATE" "DELETE" "DAY-2"
requiredApproval
boolean
required
object or object or object or object
required
object

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "title": "string",
  • "icon": "string",
  • "description": "string",
  • "trigger": "CREATE",
  • "requiredApproval": true,
  • "invocationMethod": {
    },
  • "userInputs": {
    }
}

/v1/blueprints/{blueprint_identifier}/actions/{action_identifier}

Authorizations:
bearer
path Parameters
action_identifier
required
string
blueprint_identifier
required
string

Responses

/v1/blueprints/{blueprint_identifier}/actions/{action_identifier}

Authorizations:
bearer
path Parameters
action_identifier
required
string
blueprint_identifier
required
string

Responses

/v1/actions

Authorizations:
bearer

Responses

Blueprints

/v1/blueprints/{blueprint_identifier}/permissions

Authorizations:
bearer
path Parameters
blueprint_identifier
required
string

Responses

/v1/blueprints/{blueprint_identifier}/permissions

Authorizations:
bearer
path Parameters
blueprint_identifier
required
string
Request Body schema: application/json
object
additionalProperties
any

Responses

Request samples

Content type
application/json
{
  • "entities": {
    },
  • "additionalProperties": null
}

/v1/blueprints

Authorizations:
bearer

Responses

/v1/blueprints

Authorizations:
bearer
Request Body schema: application/json
identifier
required
string <= 30 characters ^[A-Za-z0-9@_\\.\\=-]*$
title
required
string <= 30 characters
description
string <= 200 characters
icon
string
object
required
object
object
Default: {}
object
object
object or object
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "title": "string",
  • "description": "string",
  • "icon": "string",
  • "teamInheritance": {
    },
  • "schema": {
    },
  • "calculationProperties": { },
  • "mirrorProperties": {
    },
  • "relations": {
    },
  • "changelogDestination": {}
}

/v1/blueprints/{identifier}

Authorizations:
bearer
path Parameters
identifier
required
string

Responses

/v1/blueprints/{identifier}

Authorizations:
bearer
path Parameters
identifier
required
string
Request Body schema: application/json
identifier
string <= 30 characters ^[A-Za-z0-9@_\\.\\=-]*$
title
required
string <= 30 characters
description
string <= 200 characters
icon
string
object
required
object
object
Default: {}
object
object
object or object
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "title": "string",
  • "description": "string",
  • "icon": "string",
  • "teamInheritance": {
    },
  • "schema": {
    },
  • "calculationProperties": { },
  • "mirrorProperties": {
    },
  • "relations": {
    },
  • "changelogDestination": {}
}

/v1/blueprints/{identifier}

Authorizations:
bearer
path Parameters
identifier
required
string
Request Body schema: application/json
identifier
string <= 30 characters ^[A-Za-z0-9@_\\.\\=-]*$
title
string <= 30 characters
description
string <= 200 characters
icon
string
object
object
object
Default: {}
object
object
object or object
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "title": "string",
  • "description": "string",
  • "icon": "string",
  • "teamInheritance": {
    },
  • "schema": {
    },
  • "calculationProperties": { },
  • "mirrorProperties": {
    },
  • "relations": {
    },
  • "changelogDestination": {}
}

/v1/blueprints/{identifier}

Authorizations:
bearer
path Parameters
identifier
required
string

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

/v1/blueprints/{identifier}/properties/{property_name}/rename

Authorizations:
bearer
path Parameters
identifier
required
string
property_name
required
string
Request Body schema: application/json
newPropertyName
string

Responses

Request samples

Content type
application/json
{
  • "newPropertyName": "string"
}

/v1/blueprints/{identifier}/mirror/{mirror_name}/rename

Authorizations:
bearer
path Parameters
identifier
required
string
mirror_name
required
string
Request Body schema: application/json
newMirrorName
string

Responses

Request samples

Content type
application/json
{
  • "newMirrorName": "string"
}

/v1/blueprints/{identifier}/relations/{relation_identifier}/rename

Authorizations:
bearer
path Parameters
identifier
required
string
relation_identifier
required
string
Request Body schema: application/json
newRelationIdentifier
string

Responses

Request samples

Content type
application/json
{
  • "newRelationIdentifier": "string"
}

Pages

/v1/pages/{page_identifier}/permissions

Authorizations:
bearer
path Parameters
page_identifier
required
string

Responses

/v1/pages/{page_identifier}/permissions

Authorizations:
bearer
path Parameters
page_identifier
required
string
Request Body schema: application/json
object
users
Array of strings
roles
Array of strings
teams
Array of strings

Responses

Request samples

Content type
application/json
{
  • "read": {
    }
}

/v1/pages

Authorizations:
bearer
query Parameters
compact
required
boolean
Default: false

Responses

/v1/pages

Authorizations:
bearer
Request Body schema: application/json
identifier
required
string^[A-Za-z0-9@_\\.\\=-]*$
blueprint
required
string
title
string
icon
string
showInSidebar
boolean
Default: true
section
string
Default: "software_catalog"
Enum: "software_catalog" "organization"
locked
boolean
requiredQueryParams
Array of strings
Array of objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or /schemas/grouperWidget (object) or objects non-empty

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "blueprint": "string",
  • "title": "string",
  • "icon": "string",
  • "showInSidebar": true,
  • "section": "software_catalog",
  • "locked": true,
  • "requiredQueryParams": [
    ],
  • "widgets": [
    ]
}

/v1/pages/{identifier}

Authorizations:
bearer
path Parameters
identifier
required
string

Responses

/v1/pages/{identifier}

Authorizations:
bearer
path Parameters
identifier
required
string
Request Body schema: application/json
locked
required
boolean

Responses

Request samples

Content type
application/json
{
  • "locked": true
}

Response samples

Content type
application/json
{
  • "ok": true,
  • "identifier": "string"
}

/v1/pages/{identifier}

Authorizations:
bearer
path Parameters
identifier
required
string

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Authentication / Authorization

/v1/auth/access_token

Request Body schema: application/json
clientId
required
string
clientSecret
required
string

Responses

Request samples

Content type
application/json
{
  • "clientId": "string",
  • "clientSecret": "string"
}

Response samples

Content type
application/json
{
  • "ok": true,
  • "accessToken": "string",
  • "expiresIn": 0,
  • "tokenType": "string"
}

/v1/auth/permissions

Authorizations:
bearer

Responses

Action Runs

/v1/blueprints/{blueprint_identifier}/entities/{entity_identifier}/actions/{action_identifier}/runs

Authorizations:
bearer
path Parameters
action_identifier
required
string
blueprint_identifier
required
string
entity_identifier
required
string
query Parameters
run_id
string
Request Body schema: application/json
properties
required
object

Responses

Request samples

Content type
application/json
{
  • "properties": { }
}

/v1/blueprints/{blueprint_identifier}/actions/{action_identifier}/runs

Authorizations:
bearer
path Parameters
action_identifier
required
string
blueprint_identifier
required
string
query Parameters
run_id
string
Request Body schema: application/json
properties
required
object

Responses

Request samples

Content type
application/json
{
  • "properties": { }
}

/v1/actions/runs/{run_id}

Authorizations:
bearer
path Parameters
run_id
required
string
Request Body schema: application/json
status
string
Enum: "SUCCESS" "FAILURE"
string or Array of strings
message
object
Deprecated
summary
string
externalRunId
string

Responses

Request samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "link": "string",
  • "message": { },
  • "summary": "string",
  • "externalRunId": "string"
}

/v1/actions/runs/{run_id}

Authorizations:
bearer
path Parameters
run_id
required
string

Responses

/v1/actions/runs/{run_id}/approval

Authorizations:
bearer
path Parameters
run_id
required
string
Request Body schema: application/json
status
required
string
Enum: "APPROVE" "DECLINE"
description
string

Responses

Request samples

Content type
application/json
{
  • "status": "APPROVE",
  • "description": "string"
}

/v1/actions/runs

Authorizations:
bearer
query Parameters
entity
string
blueprint
string
active
boolean
user_email
string
limit
number [ 1 .. 50 ]
external_run_id
string

Responses

/v1/actions/runs/{run_id}/logs

Authorizations:
bearer
path Parameters
run_id
required
string
Request Body schema: application/json
terminationStatus
string
Enum: "SUCCESS" "FAILURE"
message
required
string

Responses

Request samples

Content type
application/json
{
  • "terminationStatus": "SUCCESS",
  • "message": "string"
}

/v1/actions/runs/{run_id}/logs

Authorizations:
bearer
path Parameters
run_id
required
string
query Parameters
limit
number [ 1 .. 50 ]
offset
number

Responses

Entities

/v1/blueprints/{blueprint_identifier}/entities

Authorizations:
bearer
path Parameters
blueprint_identifier
required
string
query Parameters
upsert
required
boolean
Default: false
validation_only
boolean
Default: false
merge
boolean
Default: false
run_id
string
Request Body schema: application/json
identifier
string^[A-Za-z0-9@_\\.\\=-]*$
title
string
icon
string
string or Array of strings
properties
required
object
object
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "title": "string",
  • "icon": "string",
  • "team": "string",
  • "properties": { },
  • "relations": {
    }
}

/v1/blueprints/{blueprint_identifier}/entities

Authorizations:
bearer
path Parameters
blueprint_identifier
required
string
query Parameters
exclude_calculated_properties
boolean
Default: false
include
Array of strings
attach_title_to_relation
boolean
Default: false

Responses

/v1/blueprints/{blueprint_identifier}/entities/{entity_identifier}

Authorizations:
bearer
path Parameters
entity_identifier
required
string
blueprint_identifier
required
string
query Parameters
run_id
string
Request Body schema: application/json
identifier
string^[A-Za-z0-9@_\\.\\=-]*$
title
string or null
icon
string or null
(string or null) or Array of strings
properties
object
object

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "title": "string",
  • "icon": "string",
  • "team": "string",
  • "properties": { },
  • "relations": {
    }
}

/v1/blueprints/{blueprint_identifier}/entities/{entity_identifier}

Authorizations:
bearer
path Parameters
entity_identifier
required
string
blueprint_identifier
required
string
query Parameters
run_id
string
Request Body schema: application/json
identifier
string^[A-Za-z0-9@_\\.\\=-]*$
title
string
icon
string
string or Array of strings
properties
required
object
object
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "title": "string",
  • "icon": "string",
  • "team": "string",
  • "properties": { },
  • "relations": {
    }
}

/v1/blueprints/{blueprint_identifier}/entities/{entity_identifier}

Authorizations:
bearer
path Parameters
entity_identifier
required
string
blueprint_identifier
required
string
query Parameters
exclude_calculated_properties
boolean
Default: false
include
Array of strings
attach_title_to_relation
boolean
Default: false

Responses

/v1/blueprints/{blueprint_identifier}/entities/{entity_identifier}

Authorizations:
bearer
path Parameters
entity_identifier
required
string
blueprint_identifier
required
string
query Parameters
delete_dependents
required
boolean
Default: false
run_id
string

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

/v1/blueprints/{blueprint_identifier}/all-entities

Authorizations:
bearer
path Parameters
blueprint_identifier
required
string
query Parameters
run_id
string

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

/v1/entities/search

Authorizations:
bearer
query Parameters
exclude_calculated_properties
boolean
Default: false
include
Array of strings
attach_title_to_relation
boolean
Default: false
Request Body schema: application/json
combinator
required
any
Enum: "and" "or"
required
Array of objects or objects or objects or objects or objects or any

Responses

Request samples

Content type
application/json
{
  • "combinator": "and",
  • "rules": [
    ]
}

Organization

/v1/organization

Authorizations:
bearer

Responses

/v1/organization

Authorizations:
bearer
Request Body schema: application/json
name
required
string
defaultPage
required
string
pageOrder
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "defaultPage": "string",
  • "pageOrder": [
    ]
}

Response samples

Content type
application/json
{
  • "ok": true
}

/v1/organization

Authorizations:
bearer
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "ok": true
}

/v1/organization

Authorizations:
bearer
Request Body schema: application/json
name
required
string [ 3 .. 30 ] characters ^[A-Za-z0-9-]*$
phoneNumber
required
string [ 3 .. 30 ] characters ^(\+|00)[1-9][0-9 \-\\(\\)\\.]{7,32}$

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "phoneNumber": "string"
}

Integrations

/v1/integration

Authorizations:
bearer

Responses

/v1/integration

Authorizations:
bearer
Request Body schema: application/json
installationId
required
string
installationAppType
string
config
object

Responses

Request samples

Content type
application/json
{
  • "installationId": "string",
  • "installationAppType": "string",
  • "config": { }
}

/v1/integration/{identifier}

Authorizations:
bearer
path Parameters
identifier
required
string

Responses

/v1/integration/{identifier}

Authorizations:
bearer
path Parameters
identifier
required
string

Responses

/v1/integration/{identifier}/config

Authorizations:
bearer
path Parameters
identifier
required
string
Request Body schema: application/json
required
object or null
Array of objects
Array
kind
required
string
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "config": {
    }
}

Webhook

/v1/webhooks

Authorizations:
bearer
Request Body schema: application/json
identifier
string <= 30 characters
title
required
string <= 30 characters
description
string <= 200 characters
icon
string
Array of objects
enabled
required
boolean
Default: true
object

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "title": "string",
  • "description": "string",
  • "icon": "string",
  • "mappings": [
    ],
  • "enabled": true,
  • "security": {
    }
}

/v1/webhooks

Authorizations:
bearer

Responses

/v1/webhooks/{identifier}

Authorizations:
bearer
path Parameters
identifier
required
string
Request Body schema: application/json
identifier
string <= 30 characters
title
string <= 30 characters
description
string <= 200 characters
icon
string
Array of objects
enabled
boolean
Default: true
object

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "title": "string",
  • "description": "string",
  • "icon": "string",
  • "mappings": [
    ],
  • "enabled": true,
  • "security": {
    }
}

/v1/webhooks/{identifier}

Authorizations:
bearer
path Parameters
identifier
required
string
Request Body schema: application/json
identifier
string <= 30 characters
title
required
string <= 30 characters
description
string <= 200 characters
icon
string
Array of objects
enabled
required
boolean
Default: true
object

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "title": "string",
  • "description": "string",
  • "icon": "string",
  • "mappings": [
    ],
  • "enabled": true,
  • "security": {
    }
}

/v1/webhooks/{identifier}

Authorizations:
bearer
path Parameters
identifier
required
string

Responses

/v1/webhooks/{identifier}

Authorizations:
bearer
path Parameters
identifier
required
string

Responses

Audit

/v1/audit-log

Authorizations:
bearer
query Parameters
identifier
string
entity
string
blueprint
string
run_id
string
webhookId
string
webhookEventId
string
Array of any or string
includes
Array of any
Items Enum: "action" "context" "diff" "identifier" "resourceType" "status" "trigger" "additionalData" "message"
from
string <date-time>

ISO format IE 2022-04-23T18:25:43.511Z

to
string <date-time>

ISO format 2022-04-23T18:25:43.511Z

action
string
status
string
Enum: "SUCCESS" "FAILURE" "TRIGGERED"
limit
number

Responses

Teams

/v1/teams

Authorizations:
bearer
query Parameters
fields
Array of any
Items Enum: "id" "name" "createdAt" "updatedAt" "provider" "description" "users.firstName" "users.lastName" "users.email" "users.picture" "users.status"

Responses

/v1/teams

Authorizations:
bearer
Request Body schema: application/json
name
required
string^[^;#/\?\s][^;#/\?]*[^;#/\?\s]$
users
Array of strings
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "users": [
    ],
  • "description": "string"
}

/v1/teams/{name}

Authorizations:
bearer
path Parameters
name
required
string
query Parameters
fields
Array of any
Items Enum: "id" "name" "createdAt" "updatedAt" "provider" "description" "users.firstName" "users.lastName" "users.email" "users.picture" "users.status"

Responses

/v1/teams/{name}

Authorizations:
bearer
path Parameters
name
required
string
Request Body schema: application/json
name
string
users
Array of strings
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "users": [
    ],
  • "description": "string"
}

/v1/teams/{name}

Authorizations:
bearer
path Parameters
name
required
string

Responses

Users

/v1/users

Authorizations:
bearer
query Parameters
fields
Array of strings
Items Enum: "id" "email" "firstName" "lastName" "phoneNumber" "picture" "status" "providers" "createdAt" "updatedAt" "teams.name" "teams.provider" "teams.createdAt" "teams.updatedAt" "roles.name" "roles.description" "roles.isAdmin" "roles.protected" "roles.createdAt" "roles.updatedAt"

Responses

/v1/users/invite

Authorizations:
bearer
Request Body schema: application/json
required
object
email
required
string^[^;#/\?\s][^;#/\?]*[^;#/\?\s]$
roles
Array of strings
teams
Array of strings

Responses

Request samples

Content type
application/json
{
  • "invitee": {
    }
}

/v1/users/{user_email}

Authorizations:
bearer
path Parameters
user_email
required
string

Responses

/v1/users/{user_email}

Authorizations:
bearer
path Parameters
user_email
required
string
Request Body schema: application/json
roles
Array of strings non-empty
teams
Array of strings

Responses

Request samples

Content type
application/json
{
  • "roles": [
    ],
  • "teams": [
    ]
}

/v1/users/{user_email}

Authorizations:
bearer
path Parameters
user_email
required
string

Responses

Apps

/v1/apps

Authorizations:
bearer
query Parameters
fields
Array of strings
Items Enum: "id" "name" "createdAt" "updatedAt" "secret"

Responses

KafkaCredentials

/v1/kafka-credentials

Authorizations:
bearer

Responses

Roles

/v1/roles

Authorizations:
bearer
query Parameters
fields
Array of strings
Items Enum: "id" "name" "description" "createdAt" "updatedAt"

Responses

Scorecards

/v1/blueprints/{blueprint_identifier}/scorecards

Authorizations:
bearer
path Parameters
blueprint_identifier
required
string
Request Body schema: application/json
identifier
required
string^[A-Za-z0-9@_\\.\\=-]*$
title
required
string
object
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "title": "string",
  • "filter": {
    },
  • "rules": [
    ]
}

/v1/blueprints/{blueprint_identifier}/scorecards

Authorizations:
bearer
path Parameters
blueprint_identifier
required
string
Request Body schema: application/json
Array
identifier
required
string^[A-Za-z0-9@_\\.\\=-]*$
title
required
string
object
required
Array of objects
id
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

/v1/blueprints/{blueprint_identifier}/scorecards

Authorizations:
bearer
path Parameters
blueprint_identifier
required
string

Responses

/v1/blueprints/{blueprint_identifier}/scorecards/{scorecard_identifier}

Authorizations:
bearer
path Parameters
scorecard_identifier
required
string
blueprint_identifier
required
string
Request Body schema: application/json
identifier
required
string^[A-Za-z0-9@_\\.\\=-]*$
title
required
string
object
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "title": "string",
  • "filter": {
    },
  • "rules": [
    ]
}

/v1/blueprints/{blueprint_identifier}/scorecards/{scorecard_identifier}

Authorizations:
bearer
path Parameters
scorecard_identifier
required
string
blueprint_identifier
required
string

Responses

/v1/blueprints/{blueprint_identifier}/scorecards/{scorecard_identifier}

Authorizations:
bearer
path Parameters
scorecard_identifier
required
string
blueprint_identifier
required
string

Responses

/v1/scorecards

Authorizations:
bearer

Responses

Templates

/v1/templates

Authorizations:
bearer

Responses