Port API

naftiko: 1.0.0-alpha2
info:
  label: Port API
  description: Port API API capability.
  tags:
  - Port
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: port
    baseUri: https://api.example.com
    description: Port API HTTP API.
    authentication:
      type: apikey
      in: header
      name: Authorization
      value: '{{PORT_TOKEN}}'
    resources:
    - name: v1-blueprints-blueprint-identifier-permissions
      path: /v1/blueprints/{blueprint_identifier}/permissions
      operations:
      - name: get-v1-blueprints-blueprint-identifier-permissio
        method: GET
        description: Get a blueprint's permissions
        inputParameters:
        - name: blueprint_identifier
          in: path
          type: string
          required: true
          description: The identifier of the blueprint to operate on.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch-v1-blueprints-blueprint-identifier-permiss
        method: PATCH
        description: Update a blueprint's permissions
        inputParameters:
        - name: blueprint_identifier
          in: path
          type: string
          required: true
          description: The identifier of the blueprint to operate on.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-blueprints-blueprint-identifier-permissions-s
      path: /v1/blueprints/{blueprint_identifier}/permissions/simulate
      operations:
      - name: post-v1-blueprints-blueprint-identifier-permissi
        method: POST
        description: Simulate permissions for a user
        inputParameters:
        - name: blueprint_identifier
          in: path
          type: string
          required: true
          description: The identifier of the blueprint to operate on.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-pages-page-identifier-permissions
      path: /v1/pages/{page_identifier}/permissions
      operations:
      - name: get-v1-pages-page-identifier-permissions
        method: GET
        description: Get a page's permissions
        inputParameters:
        - name: page_identifier
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch-v1-pages-page-identifier-permissions
        method: PATCH
        description: Update a page's permissions
        inputParameters:
        - name: page_identifier
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-auth-access-token
      path: /v1/auth/access_token
      operations:
      - name: post-v1-auth-access-token
        method: POST
        description: Create an access token
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-blueprints-blueprint-identifier-entities
      path: /v1/blueprints/{blueprint_identifier}/entities
      operations:
      - name: post-v1-blueprints-blueprint-identifier-entities
        method: POST
        description: Create an entity
        inputParameters:
        - name: upsert
          in: query
          type: boolean
          required: true
          description: If `true`, this call will override the entire entity/ies, if it/they already exist/s.
        - name: validation_only
          in: query
          type: boolean
          description: If `true`, this call will only validate the entity/ies and return the validation errors.
        - name: create_missing_related_entities
          in: query
          type: boolean
          description: If `true`, this call will also create missing related entities.<br/>This is useful when you want to
            create an entity and its related entities in one call, or if
        - name: merge
          in: query
          type: boolean
          description: If `true` and `upsert` is also `true`, this call will update the entity/ies, if it/they already exist/s.
        - name: run_id
          in: query
          type: string
          description: You can provide a `run_id` to associate the created entities with a specific [action run](https://docs.port.io/create-self-service-experiences/reflect-action-pr
        - name: ocean_info_resync_id
          in: query
          type: string
          description: Resync run identifier. Only valid when `ocean_info_event_type` is `resync`.
        - name: ocean_info_event_type
          in: query
          type: string
          description: How the operation was triggered.
        - name: blueprint_identifier
          in: path
          type: string
          required: true
          description: The identifier of the blueprint to operate on.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get-v1-blueprints-blueprint-identifier-entities
        method: GET
        description: Get all entities of a blueprint
        inputParameters:
        - name: exclude_calculated_properties
          in: query
          type: boolean
          description: If `true`, [calculated properties](https://docs.getport.io/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/ca
        - name: include
          in: query
          type: array
          description: An array of values from the [entity JSON](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#json-structure).
            Only these values will be retu
        - name: exclude
          in: query
          type: array
          description: An array of values from the [entity JSON](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#json-structure)
            to be ommitted from the respons
        - name: attach_title_to_relation
          in: query
          type: boolean
        - name: attach_identifier_to_title_mirror_properties
          in: query
          type: boolean
        - name: allow_partial_results
          in: query
          type: boolean
          description: When enabled allows some of the blueprint searches to fail without failing the full request.
        - name: blueprint_identifier
          in: path
          type: string
          required: true
          description: The identifier of the blueprint to operate on.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-blueprints-blueprint-identifier-entities-bulk
      path: /v1/blueprints/{blueprint_identifier}/entities/bulk
      operations:
      - name: post-v1-blueprints-blueprint-identifier-entities
        method: POST
        description: Create multiple entities
        inputParameters:
        - name: upsert
          in: query
          type: boolean
          required: true
          description: If `true`, this call will override the entire entity/ies, if it/they already exist/s.
        - name: validation_only
          in: query
          type: boolean
          description: If `true`, this call will only validate the entity/ies and return the validation errors.
        - name: create_missing_related_entities
          in: query
          type: boolean
          description: If `true`, this call will also create missing related entities.<br/>This is useful when you want to
            create an entity and its related entities in one call, or if
        - name: merge
          in: query
          type: boolean
          description: If `true` and `upsert` is also `true`, this call will update the entity/ies, if it/they already exist/s.
        - name: run_id
          in: query
          type: string
          description: You can provide a `run_id` to associate the created entities with a specific [action run](https://docs.port.io/create-self-service-experiences/reflect-action-pr
        - name: ocean_info_resync_id
          in: query
          type: string
          description: Resync run identifier. Only valid when `ocean_info_event_type` is `resync`.
        - name: ocean_info_event_type
          in: query
          type: string
          description: How the operation was triggered.
        - name: blueprint_identifier
          in: path
          type: string
          required: true
          description: The identifier of the blueprint to operate on.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-blueprints-blueprint-identifier-entities-enti
      path: /v1/blueprints/{blueprint_identifier}/entities/{entity_identifier}
      operations:
      - name: patch-v1-blueprints-blueprint-identifier-entitie
        method: PATCH
        description: Update an entity
        inputParameters:
        - name: create_missing_related_entities
          in: query
          type: boolean
          description: If `true`, this call will also create missing related entities.<br/>This is useful when you want to
            create an entity and its related entities in one call, or if
        - name: run_id
          in: query
          type: string
          description: You can provide a `run_id` to associate the created entities with a specific [action run](https://docs.port.io/create-self-service-experiences/reflect-action-pr
        - name: ocean_info_resync_id
          in: query
          type: string
          description: Resync run identifier. Only valid when `ocean_info_event_type` is `resync`.
        - name: ocean_info_event_type
          in: query
          type: string
          description: How the operation was triggered.
        - name: entity_identifier
          in: path
          type: string
          required: true
          description: The identifier of the entity to operate on.
        - name: blueprint_identifier
          in: path
          type: string
          required: true
          description: The identifier of the blueprint to operate on.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: put-v1-blueprints-blueprint-identifier-entities-
        method: PUT
        description: Change an entity
        inputParameters:
        - name: create_missing_related_entities
          in: query
          type: boolean
          description: If `true`, this call will also create missing related entities.<br/>This is useful when you want to
            create an entity and its related entities in one call, or if
        - name: run_id
          in: query
          type: string
          description: You can provide a `run_id` to associate the created entities with a specific [action run](https://docs.port.io/create-self-service-experiences/reflect-action-pr
        - name: ocean_info_resync_id
          in: query
          type: string
          description: Resync run identifier. Only valid when `ocean_info_event_type` is `resync`.
        - name: ocean_info_event_type
          in: query
          type: string
          description: How the operation was triggered.
        - name: entity_identifier
          in: path
          type: string
          required: true
          description: The identifier of the entity to operate on.
        - name: blueprint_identifier
          in: path
          type: string
          required: true
          description: The identifier of the blueprint to operate on.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get-v1-blueprints-blueprint-identifier-entities-
        method: GET
        description: Get an entity
        inputParameters:
        - name: exclude_calculated_properties
          in: query
          type: boolean
          description: If `true`, [calculated properties](https://docs.getport.io/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/ca
        - name: include
          in: query
          type: array
          description: An array of values from the [entity JSON](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#json-structure).
            Only these values will be retu
        - name: exclude
          in: query
          type: array
          description: An array of values from the [entity JSON](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#json-structure)
            to be ommitted from the respons
        - name: attach_title_to_relation
          in: query
          type: boolean
        - name: attach_identifier_to_title_mirror_properties
          in: query
          type: boolean
        - name: allow_partial_results
          in: query
          type: boolean
          description: When enabled allows some of the blueprint searches to fail without failing the full request.
        - name: entity_identifier
          in: path
          type: string
          required: true
          description: The identifier of the entity to operate on.
        - name: blueprint_identifier
          in: path
          type: string
          required: true
          description: The identifier of the blueprint to operate on.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: delete-v1-blueprints-blueprint-identifier-entiti
        method: DELETE
        description: Delete an entity
        inputParameters:
        - name: delete_dependents
          in: query
          type: boolean
          required: true
          description: If `true`, this call will also delete all entities with a relation to the deleted entity.
        - name: run_id
          in: query
          type: string
          description: You can provide a `run_id` to associate the created entities with a specific [action run](https://docs.port.io/create-self-service-experiences/reflect-action-pr
        - name: ocean_info_resync_id
          in: query
          type: string
          description: Resync run identifier. Only valid when `ocean_info_event_type` is `resync`.
        - name: ocean_info_event_type
          in: query
          type: string
          description: How the operation was triggered.
        - name: entity_identifier
          in: path
          type: string
          required: true
          description: The identifier of the entity to operate on.
        - name: blueprint_identifier
          in: path
          type: string
          required: true
          description: The identifier of the blueprint to operate on.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-blueprints-blueprint-identifier-entities-coun
      path: /v1/blueprints/{blueprint_identifier}/entities-count
      operations:
      - name: get-v1-blueprints-blueprint-identifier-entities-
        method: GET
        description: Get a blueprint's entity count
        inputParameters:
        - name: blueprint_identifier
          in: path
          type: string
          required: true
          description: The identifier of the blueprint to operate on.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-blueprints-blueprint-identifier-all-entities
      path: /v1/blueprints/{blueprint_identifier}/all-entities
      operations:
      - name: delete-v1-blueprints-blueprint-identifier-all-en
        method: DELETE
        description: Delete all entities of a blueprint
        inputParameters:
        - name: run_id
          in: query
          type: string
          description: You can provide a `run_id` to associate the deleted entities with a specific [action run](https://docs.port.io/create-self-service-experiences/reflect-action-pr
        - name: ocean_info_resync_id
          in: query
          type: string
          description: Resync run identifier. Only valid when `ocean_info_event_type` is `resync`.
        - name: ocean_info_event_type
          in: query
          type: string
          description: How the operation was triggered.
        - name: delete_blueprint
          in: query
          type: boolean
          description: If `true`, this call will also delete the blueprint itself.
        - name: blueprint_identifier
          in: path
          type: string
          required: true
          description: The identifier of the blueprint to operate on.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-blueprints-blueprint-identifier-bulk-entities
      path: /v1/blueprints/{blueprint_identifier}/bulk/entities/delete
      operations:
      - name: post-v1-blueprints-blueprint-identifier-bulk-ent
        method: POST
        description: Delete multiple entities
        inputParameters:
        - name: delete_dependents
          in: query
          type: boolean
          required: true
          description: If `true`, this call will also delete all entities with a relation to the deleted entity.
        - name: run_id
          in: query
          type: string
          description: You can provide a `run_id` to associate the created entities with a specific [action run](https://docs.port.io/create-self-service-experiences/reflect-action-pr
        - name: ocean_info_resync_id
          in: query
          type: string
          description: Resync run identifier. Only valid when `ocean_info_event_type` is `resync`.
        - name: ocean_info_event_type
          in: query
          type: string
          description: How the operation was triggered.
        - name: blueprint_identifier
          in: path
          type: string
          required: true
          description: The identifier of the blueprint to operate on.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-entities-search
      path: /v1/entities/search
      operations:
      - name: post-v1-entities-search
        method: POST
        description: Search entities
        inputParameters:
        - name: exclude_calculated_properties
          in: query
          type: boolean
          description: If `true`, [calculated properties](https://docs.getport.io/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/ca
        - name: include
          in: query
          type: array
          description: An array of values from the [entity JSON](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#json-structure).
            Only these values will be retu
        - name: exclude
          in: query
          type: array
          description: An array of values from the [entity JSON](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#json-structure)
            to be ommitted from the respons
        - name: attach_title_to_relation
          in: query
          type: boolean
        - name: attach_identifier_to_title_mirror_properties
          in: query
          type: boolean
        - name: allow_partial_results
          in: query
          type: boolean
          description: When enabled allows some of the blueprint searches to fail without failing the full request.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-blueprints-blueprint-identifier-entities-sear
      path: /v1/blueprints/{blueprint_identifier}/entities/search
      operations:
      - name: post-v1-blueprints-blueprint-identifier-entities
        method: POST
        description: Search a blueprint's entities
        inputParameters:
        - name: blueprint_identifier
          in: path
          type: string
          required: true
          description: The identifier of the blueprint whose entities you want to search.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-entities-aggregate
      path: /v1/entities/aggregate
      operations:
      - name: post-v1-entities-aggregate
        method: POST
        description: Aggregate entities
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-entities-aggregate-over-time
      path: /v1/entities/aggregate-over-time
      operations:
      - name: post-v1-entities-aggregate-over-time
        method: POST
        description: Aggregate entities over time
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-entities-properties-history
      path: /v1/entities/properties-history
      operations:
      - name: post-v1-entities-properties-history
        method: POST
        description: Fetch the history of an entity's properties
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-blueprints
      path: /v1/blueprints
      operations:
      - name: get-v1-blueprints
        method: GET
        description: Get all blueprints
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post-v1-blueprints
        method: POST
        description: Create a blueprint
        inputParameters:
        - name: create_catalog_page
          in: query
          type: boolean
          description: If true, a catalog page will be created for this blueprint
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-blueprints-identifier
      path: /v1/blueprints/{identifier}
      operations:
      - name: get-v1-blueprints-identifier
        method: GET
        description: Get a blueprint
        inputParameters:
        - name: identifier
          in: path
          type: string
          required: true
          description: The unique identifier of the resource you want to operate on.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: put-v1-blueprints-identifier
        method: PUT
        description: Change a blueprint
        inputParameters:
        - name: identifier
          in: path
          type: string
          required: true
          description: The unique identifier of the resource you want to operate on.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patch-v1-blueprints-identifier
        method: PATCH
        description: Update a blueprint
        inputParameters:
        - name: identifier
          in: path
          type: string
          required: true
          description: The unique identifier of the resource you want to operate on.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: delete-v1-blueprints-identifier
        method: DELETE
        description: Delete a blueprint
        inputParameters:
        - name: delete_actions
          in: query
          type: boolean
          description: If `true`, all self-service actions associated with this blueprint will be deleted as well.
        - name: identifier
          in: path
          type: string
          required: true
          description: The unique identifier of the resource you want to operate on.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-blueprints-blueprint-identifier-properties-pr
      path: /v1/blueprints/{blueprint_identifier}/properties/{property_identifier}/rename
      operations:
      - name: patch-v1-blueprints-blueprint-identifier-propert
        method: PATCH
        description: Rename a property in a blueprint
        inputParameters:
        - name: blueprint_identifier
          in: path
          type: string
          required: true
          description: The identifier of the blueprint you want to change.
        - name: property_identifier
          in: path
          type: string
          required: true
          description: The identifier of the property you want to rename.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-blueprints-blueprint-identifier-mirror-proper
      path: /v1/blueprints/{blueprint_identifier}/mirror/{property_identifier}/rename
      operations:
      - name: patch-v1-blueprints-blueprint-identifier-mirror-
        method: PATCH
        description: Rename a blueprint's mirror property
        inputParameters:
        - name: blueprint_identifier
          in: path
          type: string
          required: true
          description: The identifier of the blueprint you want to change.
        - name: property_identifier
          in: path
          type: string
          required: true
          description: The identifier of the property you want to rename.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-blueprints-blueprint-identifier-relations-rel
      path: /v1/blueprints/{blueprint_identifier}/relations/{relation_identifier}/rename
      operations:
      - name: patch-v1-blueprints-blueprint-identifier-relatio
        method: PATCH
        description: Rename a blueprint's relation
        inputParameters:
        - name: blueprint_identifier
          in: path
          type: string
          required: true
          description: The identifier of the blueprint you want to change.
        - name: relation_identifier
          in: path
          type: string
          required: true
          description: The identifier of the relation you want to rename.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-actions
      path: /v1/actions
      operations:
      - name: post-v1-actions
        method: POST
        description: Create an action/automation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get-v1-actions
        method: GET
        description: Get actions/automations
        inputParameters:
        - name: action_identifier
          in: query
          type: array
          description: The identifier/s of the action/s and/or automation/s you want to fetch.
        - name: blueprint_identifier
          in: query
          type: array
          description: The identifier/s of the blueprint/s whose actions/automations you wish to fetch.
        - name: operation
          in: query
          type: array
          description: The [operation type/s](https://docs.port.io/create-self-service-experiences/setup-ui-for-action/#basic-details)
            of the action/s you want to fetch. Relevant only
        - name: published
          in: query
          type: boolean
          description: Only relevant for **automations**. If `true`, only published automations will be fetched.
        - name: trigger_type
          in: query
          type: string
        - name: trigger_event
          in: query
          type: array
          description: The event/s that triggered the automation/s you want to fetch. Relevant only for automations.
        - name: trigger_event_action_identifier
          in: query
          type: array
        - name: version
          in: query
          type: string
          description: Specifies the API version to use. Please use `v2` for the latest version of the API.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-actions-action-identifier
      path: /v1/actions/{action_identifier}
      operations:
      - name: put-v1-actions-action-identifier
        method: PUT
        description: Change an action/automation
        inputParameters:
        - name: action_identifier
          in: path
          type: string
          required: true
          description: The identifier of the action/automation you want to operate on.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get-v1-actions-action-identifier
        method: GET
        description: Get an action/automation
        inputParameters:
        - name: action_identifier
          in: path
          type: string
          required: true
          description: The identifier of the action/automation you want to operate on.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: delete-v1-actions-action-identifier
        method: DELETE
        description: Delete an action/automation
        inputParameters:
        - name: action_identifier
          in: path
          type: string
          required: true
          description: The identifier of the action/automation you want to operate on.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-blueprints-blueprint-identifier-actions
      path: /v1/blueprints/{blueprint_identifier}/actions
      operations:
      - name: post-v1-blueprints-blueprint-identifier-actions
        method: POST
        description: This route is deprecated since November 20th 2024
        inputParameters:
        - name: type
          in: path
          type: string
          required: true
        - name: nullable
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: put-v1-blueprints-blueprint-identifier-actions
        method: PUT
        description: This route is deprecated since November 20th 2024
        inputParameters:
        - name: type
          in: path
          type: string
          required: true
        - name: nullable
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get-v1-blueprints-blueprint-identifier-actions
        method: GET
        description: This route is deprecated since November 20th 2024
        inputParameters:
        - name: type
          in: path
          type: string
          required: true
        - name: nullable
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-blueprints-blueprint-identifier-actions-actio
      path: /v1/blueprints/{blueprint_identifier}/actions/{action_identifier}
      operations:
      - name: put-v1-blueprints-blueprint-identifier-actions-a
        method: PUT
        description: This route is deprecated since November 20th 2024
        inputParameters:
        - name: type
          in: path
          type: string
          required: true
        - name: nullable
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get-v1-blueprints-blueprint-identifier-actions-a
        method: GET
        description: This route is deprecated since November 20th 2024
        inputParameters:
        - name: type
          in: path
          type: string
          required: true
        - name: nullable
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result

# --- truncated at 32 KB (115 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/port/refs/heads/main/capabilities/port-capability.yaml