🧪 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

• Actions
  • get/v1/blueprints/{blueprint_identifier}/actions/{action_identifier}/permissions
  • patch/v1/blueprints/{blueprint_identifier}/actions/{action_identifier}/permissions
  • post/v1/blueprints/{blueprint_identifier}/actions
  • put/v1/blueprints/{blueprint_identifier}/actions
  • get/v1/blueprints/{blueprint_identifier}/actions
  • put/v1/blueprints/{blueprint_identifier}/actions/{action_identifier}
  • get/v1/blueprints/{blueprint_identifier}/actions/{action_identifier}
  • del/v1/blueprints/{blueprint_identifier}/actions/{action_identifier}
  • get/v1/actions
• Blueprints
  • get/v1/blueprints/{blueprint_identifier}/permissions
  • patch/v1/blueprints/{blueprint_identifier}/permissions
  • get/v1/blueprints
  • post/v1/blueprints
  • get/v1/blueprints/{identifier}
  • put/v1/blueprints/{identifier}
  • patch/v1/blueprints/{identifier}
  • del/v1/blueprints/{identifier}
  • patch/v1/blueprints/{identifier}/properties/{property_name}/rename
  • patch/v1/blueprints/{identifier}/mirror/{mirror_name}/rename
  • patch/v1/blueprints/{identifier}/relations/{relation_identifier}/rename
• Pages
  • get/v1/pages/{page_identifier}/permissions
  • patch/v1/pages/{page_identifier}/permissions
  • get/v1/pages
  • post/v1/pages
  • get/v1/pages/{identifier}
  • patch/v1/pages/{identifier}
  • del/v1/pages/{identifier}
• Authentication / Authorization
  • post/v1/auth/access_token
  • get/v1/auth/permissions
• Action Runs
  • post/v1/blueprints/{blueprint_identifier}/entities/{entity_identifier}/actions/{action_identifier}/runs
  • post/v1/blueprints/{blueprint_identifier}/actions/{action_identifier}/runs
  • patch/v1/actions/runs/{run_id}
  • get/v1/actions/runs/{run_id}
  • patch/v1/actions/runs/{run_id}/approval
  • get/v1/actions/runs
  • post/v1/actions/runs/{run_id}/logs
  • get/v1/actions/runs/{run_id}/logs
• Entities
  • post/v1/blueprints/{blueprint_identifier}/entities
  • get/v1/blueprints/{blueprint_identifier}/entities
  • patch/v1/blueprints/{blueprint_identifier}/entities/{entity_identifier}
  • put/v1/blueprints/{blueprint_identifier}/entities/{entity_identifier}
  • get/v1/blueprints/{blueprint_identifier}/entities/{entity_identifier}
  • del/v1/blueprints/{blueprint_identifier}/entities/{entity_identifier}
  • del/v1/blueprints/{blueprint_identifier}/all-entities
  • post/v1/entities/search
• Organization
  • get/v1/organization
  • put/v1/organization
  • patch/v1/organization
  • post/v1/organization
• Integrations
  • get/v1/integration
  • post/v1/integration
  • get/v1/integration/{identifier}
  • del/v1/integration/{identifier}
  • patch/v1/integration/{identifier}/config
• Webhook
  • post/v1/webhooks
  • get/v1/webhooks
  • patch/v1/webhooks/{identifier}
  • put/v1/webhooks/{identifier}
  • get/v1/webhooks/{identifier}
  • del/v1/webhooks/{identifier}
• Audit
  • get/v1/audit-log
• Teams
  • get/v1/teams
  • post/v1/teams
  • get/v1/teams/{name}
  • patch/v1/teams/{name}
  • del/v1/teams/{name}
• Users
  • get/v1/users
  • post/v1/users/invite
  • get/v1/users/{user_email}
  • patch/v1/users/{user_email}
  • del/v1/users/{user_email}
• Apps
  • get/v1/apps
• KafkaCredentials
  • get/v1/kafka-credentials
• Roles
  • get/v1/roles
• Scorecards
  • post/v1/blueprints/{blueprint_identifier}/scorecards
  • put/v1/blueprints/{blueprint_identifier}/scorecards
  • get/v1/blueprints/{blueprint_identifier}/scorecards
  • put/v1/blueprints/{blueprint_identifier}/scorecards/{scorecard_identifier}
  • get/v1/blueprints/{blueprint_identifier}/scorecards/{scorecard_identifier}
  • del/v1/blueprints/{blueprint_identifier}/scorecards/{scorecard_identifier}
  • get/v1/scorecards
• Templates
  • get/v1/templates

API docs by Redocly

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

https://api.getport.io/v1/blueprints/{blueprint_identifier}/actions/{action_identifier}/permissions

/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

https://api.getport.io/v1/blueprints/{blueprint_identifier}/actions/{action_identifier}/permissions

Request samples

• Payload

Content type

application/json

{

• "execute": {

  • "users": [

    • "string"

    ],
  • "roles": [

    • "string"

    ],
  • "teams": [

    • "string"

    ],
  • "ownedByTeam": true

  },
• "approve": {

  • "users": [

    • "string"

    ],
  • "roles": [

    • "string"

    ]

  }

}

/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

https://api.getport.io/v1/blueprints/{blueprint_identifier}/actions

Request samples

• Payload

Content type

application/json

{

• "identifier": "string",
• "title": "string",
• "icon": "string",
• "description": "string",
• "trigger": "CREATE",
• "requiredApproval": true,
• "invocationMethod": {

  • "type": "GITHUB",
  • "org": "string",
  • "repo": "string",
  • "workflow": "string",
  • "omitPayload": true,
  • "omitUserInputs": true,
  • "reportWorkflowStatus": true

  },
• "userInputs": {

  • "properties": {

    • "property1": {

      • "type": "string",
      • "format": "date-time",
      • "blueprint": "string",
      • "icon": "string"

      },
    • "property2": {

      • "type": "string",
      • "format": "date-time",
      • "blueprint": "string",
      • "icon": "string"

      }

    },
  • "required": [

    • "string"

    ]

  }

}

/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

https://api.getport.io/v1/blueprints/{blueprint_identifier}/actions

Request samples

• Payload

Content type

application/json

[

• {

  • "identifier": "string",
  • "title": "string",
  • "icon": "string",
  • "description": "string",
  • "trigger": "CREATE",
  • "requiredApproval": true,
  • "invocationMethod": {

    • "type": "GITHUB",
    • "org": "string",
    • "repo": "string",
    • "workflow": "string",
    • "omitPayload": true,
    • "omitUserInputs": true,
    • "reportWorkflowStatus": true

    },
  • "userInputs": {

    • "properties": {

      • "property1": {

        • "type": "string",
        • "format": "date-time",
        • "blueprint": "string",
        • "icon": "string"

        },
      • "property2": {

        • "type": "string",
        • "format": "date-time",
        • "blueprint": "string",
        • "icon": "string"

        }

      },
    • "required": [

      • "string"

      ]

    },
  • "id": "string"

  }

]

/v1/blueprints/{blueprint_identifier}/actions

Authorizations:

bearer

path Parameters

blueprint_identifier required

string

Responses

https://api.getport.io/v1/blueprints/{blueprint_identifier}/actions

/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

https://api.getport.io/v1/blueprints/{blueprint_identifier}/actions/{action_identifier}

Request samples

• Payload

Content type

application/json

{

• "identifier": "string",
• "title": "string",
• "icon": "string",
• "description": "string",
• "trigger": "CREATE",
• "requiredApproval": true,
• "invocationMethod": {

  • "type": "GITHUB",
  • "org": "string",
  • "repo": "string",
  • "workflow": "string",
  • "omitPayload": true,
  • "omitUserInputs": true,
  • "reportWorkflowStatus": true

  },
• "userInputs": {

  • "properties": {

    • "property1": {

      • "type": "string",
      • "format": "date-time",
      • "blueprint": "string",
      • "icon": "string"

      },
    • "property2": {

      • "type": "string",
      • "format": "date-time",
      • "blueprint": "string",
      • "icon": "string"

      }

    },
  • "required": [

    • "string"

    ]

  }

}

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

Authorizations:

bearer

path Parameters

action_identifier required	string
blueprint_identifier required	string

Responses

https://api.getport.io/v1/blueprints/{blueprint_identifier}/actions/{action_identifier}

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

Authorizations:

bearer

path Parameters

action_identifier required	string
blueprint_identifier required	string

Responses

https://api.getport.io/v1/blueprints/{blueprint_identifier}/actions/{action_identifier}

/v1/actions

Authorizations:

bearer

Responses

https://api.getport.io/v1/actions

Blueprints

/v1/blueprints/{blueprint_identifier}/permissions

Authorizations:

bearer

path Parameters

blueprint_identifier required

string

Responses

https://api.getport.io/v1/blueprints/{blueprint_identifier}/permissions

/v1/blueprints/{blueprint_identifier}/permissions

Authorizations:

bearer

path Parameters

blueprint_identifier required

string

Request Body schema: application/json

	object
additionalProperties	any

Responses

https://api.getport.io/v1/blueprints/{blueprint_identifier}/permissions

Request samples

• Payload

Content type

application/json

{

• "entities": {

  • "register": {

    • "users": [

      • "string"

      ],
    • "teams": [

      • "string"

      ],
    • "roles": [

      • "string"

      ],
    • "ownedByTeam": true

    },
  • "update": {

    • "users": [

      • "string"

      ],
    • "teams": [

      • "string"

      ],
    • "roles": [

      • "string"

      ],
    • "ownedByTeam": true

    },
  • "unregister": {

    • "users": [

      • "string"

      ],
    • "teams": [

      • "string"

      ],
    • "roles": [

      • "string"

      ],
    • "ownedByTeam": true

    },
  • "updateProperties": {

    • "property1": {

      • "users": [

        • "string"

        ],
      • "teams": [

        • "string"

        ],
      • "roles": [

        • "string"

        ],
      • "ownedByTeam": true

      },
    • "property2": {

      • "users": [

        • "string"

        ],
      • "teams": [

        • "string"

        ],
      • "roles": [

        • "string"

        ],
      • "ownedByTeam": true

      }

    },
  • "updateRelations": {

    • "property1": {

      • "users": [

        • "string"

        ],
      • "teams": [

        • "string"

        ],
      • "roles": [

        • "string"

        ],
      • "ownedByTeam": true

      },
    • "property2": {

      • "users": [

        • "string"

        ],
      • "teams": [

        • "string"

        ],
      • "roles": [

        • "string"

        ],
      • "ownedByTeam": true

      }

    }

  },
• "additionalProperties": null

}

/v1/blueprints

Authorizations:

bearer

Responses

https://api.getport.io/v1/blueprints

/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

https://api.getport.io/v1/blueprints

Request samples

• Payload

Content type

application/json

{

• "identifier": "string",
• "title": "string",
• "description": "string",
• "icon": "string",
• "teamInheritance": {

  • "path": "string"

  },
• "schema": {

  • "properties": {

    • "property1": {

      • "title": "string",
      • "description": "string",
      • "icon": "string",
      • "type": "string",
      • "format": "date-time",
      • "spec": "embedded-url",
      • "specAuthentication": {

        • "clientId": "string",
        • "authorizationUrl": "string",
        • "tokenUrl": "string"

        }

      },
    • "property2": {

      • "title": "string",
      • "description": "string",
      • "icon": "string",
      • "type": "string",
      • "format": "date-time",
      • "spec": "embedded-url",
      • "specAuthentication": {

        • "clientId": "string",
        • "authorizationUrl": "string",
        • "tokenUrl": "string"

        }

      }

    },
  • "required": [

    • "string"

    ]

  },
• "calculationProperties": { },
• "mirrorProperties": {

  • "property1": {

    • "path": "string",
    • "title": "string"

    },
  • "property2": {

    • "path": "string",
    • "title": "string"

    }

  },
• "relations": {

  • "property1": {

    • "title": "string",
    • "target": "string",
    • "required": false,
    • "many": false,
    • "description": "string"

    },
  • "property2": {

    • "title": "string",
    • "target": "string",
    • "required": false,
    • "many": false,
    • "description": "string"

    }

  },
• "changelogDestination": {

  • "type": "WEBHOOK",
  • "agent": true,
  • "url": "http://example.com"

  }

}

/v1/blueprints/{identifier}

Authorizations:

bearer

path Parameters

identifier required

string

Responses

https://api.getport.io/v1/blueprints/{identifier}

/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

https://api.getport.io/v1/blueprints/{identifier}

Request samples

• Payload

Content type

application/json

{

• "identifier": "string",
• "title": "string",
• "description": "string",
• "icon": "string",
• "teamInheritance": {

  • "path": "string"

  },
• "schema": {

  • "properties": {

    • "property1": {

      • "title": "string",
      • "description": "string",
      • "icon": "string",
      • "type": "string",
      • "format": "date-time",
      • "spec": "embedded-url",
      • "specAuthentication": {

        • "clientId": "string",
        • "authorizationUrl": "string",
        • "tokenUrl": "string"

        }

      },
    • "property2": {

      • "title": "string",
      • "description": "string",
      • "icon": "string",
      • "type": "string",
      • "format": "date-time",
      • "spec": "embedded-url",
      • "specAuthentication": {

        • "clientId": "string",
        • "authorizationUrl": "string",
        • "tokenUrl": "string"

        }

      }

    },
  • "required": [

    • "string"

    ]

  },
• "calculationProperties": { },
• "mirrorProperties": {

  • "property1": {

    • "path": "string",
    • "title": "string"

    },
  • "property2": {

    • "path": "string",
    • "title": "string"

    }

  },
• "relations": {

  • "property1": {

    • "title": "string",
    • "target": "string",
    • "required": false,
    • "many": false,
    • "description": "string"

    },
  • "property2": {

    • "title": "string",
    • "target": "string",
    • "required": false,
    • "many": false,
    • "description": "string"

    }

  },
• "changelogDestination": {

  • "type": "WEBHOOK",
  • "agent": true,
  • "url": "http://example.com"

  }

}

/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

https://api.getport.io/v1/blueprints/{identifier}

Request samples

• Payload

Content type

application/json

{

• "identifier": "string",
• "title": "string",
• "description": "string",
• "icon": "string",
• "teamInheritance": {

  • "path": "string"

  },
• "schema": {

  • "properties": {

    • "property1": {

      • "title": "string",
      • "description": "string",
      • "icon": "string",
      • "type": "string",
      • "format": "date-time",
      • "spec": "open-api"

      },
    • "property2": {

      • "title": "string",
      • "description": "string",
      • "icon": "string",
      • "type": "string",
      • "format": "date-time",
      • "spec": "open-api"

      }

    },
  • "required": [

    • "string"

    ]

  },
• "calculationProperties": { },
• "mirrorProperties": {

  • "property1": {

    • "path": "string",
    • "title": "string"

    },
  • "property2": {

    • "path": "string",
    • "title": "string"

    }

  },
• "relations": {

  • "property1": {

    • "title": "string",
    • "target": "string",
    • "required": false,
    • "many": false,
    • "description": "string"

    },
  • "property2": {

    • "title": "string",
    • "target": "string",
    • "required": false,
    • "many": false,
    • "description": "string"

    }

  },
• "changelogDestination": {

  • "type": "WEBHOOK",
  • "agent": true,
  • "url": "http://example.com"

  }

}

/v1/blueprints/{identifier}

Authorizations:

bearer

path Parameters

identifier required

string

Responses

https://api.getport.io/v1/blueprints/{identifier}

Response samples

• 200

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

https://api.getport.io/v1/blueprints/{identifier}/properties/{property_name}/rename

Request samples

• Payload

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

https://api.getport.io/v1/blueprints/{identifier}/mirror/{mirror_name}/rename

Request samples

• Payload

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

https://api.getport.io/v1/blueprints/{identifier}/relations/{relation_identifier}/rename

Request samples

• Payload

Content type

application/json

{

• "newRelationIdentifier": "string"

}

Pages

/v1/pages/{page_identifier}/permissions

Authorizations:

bearer

path Parameters

page_identifier required

string

Responses

https://api.getport.io/v1/pages/{page_identifier}/permissions

/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

https://api.getport.io/v1/pages/{page_identifier}/permissions

Request samples

• Payload

Content type

application/json

{

• "read": {

  • "users": [

    • "string"

    ],
  • "roles": [

    • "string"

    ],
  • "teams": [

    • "string"

    ]

  }

}

/v1/pages

Authorizations:

bearer

query Parameters

compact required

boolean Default: false

Responses

https://api.getport.io/v1/pages

/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

https://api.getport.io/v1/pages

Request samples

• Payload

Content type

application/json

{

• "identifier": "string",
• "blueprint": "string",
• "title": "string",
• "icon": "string",
• "showInSidebar": true,
• "section": "software_catalog",
• "locked": true,
• "requiredQueryParams": [

  • "string"

  ],
• "widgets": [

  • {

    • "type": "entity-info",
    • "title": "string",
    • "entity": "string",
    • "hiddenQuery": [

      • "string"

      ],
    • "blueprint": "string"

    }

  ]

}

/v1/pages/{identifier}

Authorizations:

bearer

path Parameters

identifier required

string

Responses

https://api.getport.io/v1/pages/{identifier}

/v1/pages/{identifier}

Authorizations:

bearer

path Parameters

identifier required

string

Request Body schema: application/json

locked required

boolean

Responses

https://api.getport.io/v1/pages/{identifier}

Request samples

• Payload

Content type

application/json

{

• "locked": true

}

Response samples

• 200

Content type

application/json

{

• "ok": true,
• "identifier": "string"

}

/v1/pages/{identifier}

Authorizations:

bearer

path Parameters

identifier required

string

Responses

https://api.getport.io/v1/pages/{identifier}

Response samples

• 200

Content type

application/json

{

• "ok": true

}

Authentication / Authorization

/v1/auth/access_token

Request Body schema: application/json

clientId required	string
clientSecret required	string

Responses

https://api.getport.io/v1/auth/access_token

Request samples

• Payload

Content type

application/json

{

• "clientId": "string",
• "clientSecret": "string"

}

Response samples

• 200

Content type

application/json

{

• "ok": true,
• "accessToken": "string",
• "expiresIn": 0,
• "tokenType": "string"

}

/v1/auth/permissions

Authorizations:

bearer

Responses

https://api.getport.io/v1/auth/permissions

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

https://api.getport.io/v1/blueprints/{blueprint_identifier}/entities/{entity_identifier}/actions/{action_identifier}/runs

Request samples

• Payload

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

https://api.getport.io/v1/blueprints/{blueprint_identifier}/actions/{action_identifier}/runs

Request samples

• Payload

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

https://api.getport.io/v1/actions/runs/{run_id}

Request samples

• Payload

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

https://api.getport.io/v1/actions/runs/{run_id}

/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

https://api.getport.io/v1/actions/runs/{run_id}/approval

Request samples

• Payload

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

https://api.getport.io/v1/actions/runs

/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

https://api.getport.io/v1/actions/runs/{run_id}/logs

Request samples

• Payload

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

https://api.getport.io/v1/actions/runs/{run_id}/logs

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

https://api.getport.io/v1/blueprints/{blueprint_identifier}/entities

Request samples

• Payload

Content type

application/json

{

• "identifier": "string",
• "title": "string",
• "icon": "string",
• "team": "string",
• "properties": { },
• "relations": {

  • "property1": "string",
  • "property2": "string"

  }

}

/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

https://api.getport.io/v1/blueprints/{blueprint_identifier}/entities

/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

https://api.getport.io/v1/blueprints/{blueprint_identifier}/entities/{entity_identifier}

Request samples

• Payload

Content type

application/json

{

• "identifier": "string",
• "title": "string",
• "icon": "string",
• "team": "string",
• "properties": { },
• "relations": {

  • "property1": "string",
  • "property2": "string"

  }

}

/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

https://api.getport.io/v1/blueprints/{blueprint_identifier}/entities/{entity_identifier}

Request samples

• Payload

Content type

application/json

{

• "identifier": "string",
• "title": "string",
• "icon": "string",
• "team": "string",
• "properties": { },
• "relations": {

  • "property1": "string",
  • "property2": "string"

  }

}

/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

https://api.getport.io/v1/blueprints/{blueprint_identifier}/entities/{entity_identifier}

/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

https://api.getport.io/v1/blueprints/{blueprint_identifier}/entities/{entity_identifier}

Response samples

• 200

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

https://api.getport.io/v1/blueprints/{blueprint_identifier}/all-entities

Response samples

• 200

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

https://api.getport.io/v1/entities/search

Request samples

• Payload

Content type

application/json

{

• "combinator": "and",
• "rules": [

  • {

    • "property": "string",
    • "operator": ">",
    • "value": 0

    }

  ]

}

Organization

/v1/organization

Authorizations:

bearer

Responses

https://api.getport.io/v1/organization

/v1/organization

Authorizations:

bearer

Request Body schema: application/json

name required	string
defaultPage required	string
pageOrder required	Array of strings

Responses

https://api.getport.io/v1/organization

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "defaultPage": "string",
• "pageOrder": [

  • "string"

  ]

}

Response samples

• 200

Content type

application/json

{

• "ok": true

}

/v1/organization

Authorizations:

bearer

Request Body schema: application/json

name required

string

Responses

https://api.getport.io/v1/organization

Request samples

• Payload

Content type

application/json

{

• "name": "string"

}

Response samples

• 200

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

https://api.getport.io/v1/organization

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "phoneNumber": "string"

}

Integrations

/v1/integration

Authorizations:

bearer

Responses

https://api.getport.io/v1/integration

/v1/integration

Authorizations:

bearer

Request Body schema: application/json

installationId required	string
installationAppType	string
config	object

Responses

https://api.getport.io/v1/integration

Request samples

• Payload

Content type

application/json

{

• "installationId": "string",
• "installationAppType": "string",
• "config": { }

}

/v1/integration/{identifier}

Authorizations:

bearer

path Parameters

identifier required

string

Responses

https://api.getport.io/v1/integration/{identifier}

/v1/integration/{identifier}

Authorizations:

bearer

path Parameters

identifier required

string

Responses

https://api.getport.io/v1/integration/{identifier}

/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

https://api.getport.io/v1/integration/{identifier}/config

Request samples

• Payload

Content type

application/json

{

• "config": {

  • "resources": [

    • {

      • "kind": "string",
      • "selector": {

        • "query": "string"

        },
      • "port": {

        • "entity": {

          • "mappings": {

            • "identifier": "string",
            • "title": "string",
            • "blueprint": "string",
            • "properties": { },
            • "relations": { }

            }

          }

        }

      }

    ]

  }

}

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

https://api.getport.io/v1/webhooks

Request samples

• Payload

Content type

application/json

{

• "identifier": "string",
• "title": "string",
• "description": "string",
• "icon": "string",
• "mappings": [

  • {

    • "blueprint": "string",
    • "filter": "string",
    • "entity": {

      • "identifier": "string",
      • "title": "string",
      • "icon": "string",
      • "team": "string",
      • "properties": { },
      • "relations": { }

      }

    }

  ],
• "enabled": true,
• "security": {

  • "secret": "string",
  • "signatureHeaderName": "string",
  • "signatureAlgorithem": "sha1",
  • "signaturePrefix": "string",
  • "requestIdentifierPath": "string"

  }

}

/v1/webhooks

Authorizations:

bearer

Responses

https://api.getport.io/v1/webhooks

/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

https://api.getport.io/v1/webhooks/{identifier}

Request samples

• Payload

Content type

application/json

{

• "identifier": "string",
• "title": "string",
• "description": "string",
• "icon": "string",
• "mappings": [

  • {

    • "blueprint": "string",
    • "filter": "string",
    • "entity": {

      • "identifier": "string",
      • "title": "string",
      • "icon": "string",
      • "team": "string",
      • "properties": { },
      • "relations": { }

      }

    }

  ],
• "enabled": true,
• "security": {

  • "secret": "string",
  • "signatureHeaderName": "string",
  • "signatureAlgorithem": "sha1",
  • "signaturePrefix": "string",
  • "requestIdentifierPath": "string"

  }

}

/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

https://api.getport.io/v1/webhooks/{identifier}

Request samples

• Payload

Content type

application/json

{

• "identifier": "string",
• "title": "string",
• "description": "string",
• "icon": "string",
• "mappings": [

  • {

    • "blueprint": "string",
    • "filter": "string",
    • "entity": {

      • "identifier": "string",
      • "title": "string",
      • "icon": "string",
      • "team": "string",
      • "properties": { },
      • "relations": { }

      }

    }

  ],
• "enabled": true,
• "security": {

  • "secret": "string",
  • "signatureHeaderName": "string",
  • "signatureAlgorithem": "sha1",
  • "signaturePrefix": "string",
  • "requestIdentifierPath": "string"

  }

}

/v1/webhooks/{identifier}

Authorizations:

bearer

path Parameters

identifier required

string

Responses

https://api.getport.io/v1/webhooks/{identifier}

/v1/webhooks/{identifier}

Authorizations:

bearer

path Parameters

identifier required

string

Responses

https://api.getport.io/v1/webhooks/{identifier}

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

https://api.getport.io/v1/audit-log

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

https://api.getport.io/v1/teams

/v1/teams

Authorizations:

bearer

Request Body schema: application/json

name required	string^[^;#/\?\s][^;#/\?]*[^;#/\?\s]$
users	Array of strings
description	string

Responses

https://api.getport.io/v1/teams

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "users": [

  • "string"

  ],
• "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

https://api.getport.io/v1/teams/{name}

/v1/teams/{name}

Authorizations:

bearer

path Parameters

name required

string

Request Body schema: application/json

name	string
users	Array of strings
description	string

Responses

https://api.getport.io/v1/teams/{name}

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "users": [

  • "string"

  ],
• "description": "string"

}

/v1/teams/{name}

Authorizations:

bearer

path Parameters

name required

string

Responses

https://api.getport.io/v1/teams/{name}

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

https://api.getport.io/v1/users

/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

https://api.getport.io/v1/users/invite

Request samples

• Payload

Content type

application/json

{

• "invitee": {

  • "email": "string",
  • "roles": [

    • "string"

    ],
  • "teams": [

    • "string"

    ]

  }

}

/v1/users/{user_email}

Authorizations:

bearer

path Parameters

user_email required

string

Responses

https://api.getport.io/v1/users/{user_email}

/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

https://api.getport.io/v1/users/{user_email}

Request samples

• Payload

Content type

application/json

{

• "roles": [

  • "string"

  ],
• "teams": [

  • "string"

  ]

}

/v1/users/{user_email}

Authorizations:

bearer

path Parameters

user_email required

string

Responses

https://api.getport.io/v1/users/{user_email}

Apps

/v1/apps

Authorizations:

bearer

query Parameters

fields

Array of strings Items Enum: "id" "name" "createdAt" "updatedAt" "secret"

Responses

https://api.getport.io/v1/apps

KafkaCredentials

/v1/kafka-credentials

Authorizations:

bearer

Responses

https://api.getport.io/v1/kafka-credentials

Roles

/v1/roles

Authorizations:

bearer

query Parameters

fields

Array of strings Items Enum: "id" "name" "description" "createdAt" "updatedAt"

Responses

https://api.getport.io/v1/roles

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

https://api.getport.io/v1/blueprints/{blueprint_identifier}/scorecards

Request samples

• Payload

Content type

application/json

{

• "identifier": "string",
• "title": "string",
• "filter": {

  • "combinator": "and",
  • "conditions": [

    • {

      • "property": "string",
      • "operator": "=",
      • "value": "string"

      }

    ]

  },
• "rules": [

  • {

    • "identifier": "string",
    • "title": "string",
    • "level": "Gold",
    • "query": {

      • "combinator": "and",
      • "conditions": [

        • {

          • "property": "string",
          • "operator": "=",
          • "value": "string"

          }

        ]

      }

    }

  ]

}

/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

https://api.getport.io/v1/blueprints/{blueprint_identifier}/scorecards

Request samples

• Payload

Content type

application/json

[

• {

  • "identifier": "string",
  • "title": "string",
  • "filter": {

    • "combinator": "and",
    • "conditions": [

      • {

        • "property": "string",
        • "operator": "=",
        • "value": "string"

        }

      ]

    },
  • "rules": [

    • {

      • "identifier": "string",
      • "title": "string",
      • "level": "Gold",
      • "query": {

        • "combinator": "and",
        • "conditions": [

          • {

            • "property": "string",
            • "operator": "=",
            • "value": "string"

            }

          ]

        }

      }

    ],
  • "id": "string"

  }

]

/v1/blueprints/{blueprint_identifier}/scorecards

Authorizations:

bearer

path Parameters

blueprint_identifier required

string

Responses

https://api.getport.io/v1/blueprints/{blueprint_identifier}/scorecards

/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

https://api.getport.io/v1/blueprints/{blueprint_identifier}/scorecards/{scorecard_identifier}

Request samples

• Payload

Content type

application/json

{

• "identifier": "string",
• "title": "string",
• "filter": {

  • "combinator": "and",
  • "conditions": [

    • {

      • "property": "string",
      • "operator": "=",
      • "value": "string"

      }

    ]

  },
• "rules": [

  • {

    • "identifier": "string",
    • "title": "string",
    • "level": "Gold",
    • "query": {

      • "combinator": "and",
      • "conditions": [

        • {

          • "property": "string",
          • "operator": "=",
          • "value": "string"

          }

        ]

      }

    }

  ]

}

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

Authorizations:

bearer

path Parameters

scorecard_identifier required	string
blueprint_identifier required	string

Responses

https://api.getport.io/v1/blueprints/{blueprint_identifier}/scorecards/{scorecard_identifier}

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

Authorizations:

bearer

path Parameters

scorecard_identifier required	string
blueprint_identifier required	string

Responses

https://api.getport.io/v1/blueprints/{blueprint_identifier}/scorecards/{scorecard_identifier}

/v1/scorecards

Authorizations:

bearer

Responses

https://api.getport.io/v1/scorecards

Templates

/v1/templates

Authorizations:

bearer

Responses

https://api.getport.io/v1/templates