Port

opencollection: 1.0.0
info:
  name: Port API
  version: '1.0'
items:
- info:
    name: Blueprints
    type: folder
  items:
  - info:
      name: Get a blueprint's permissions
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/blueprints/:blueprint_identifier/permissions'
      params:
      - name: blueprint_identifier
        value: ''
        type: path
        description: The identifier of the blueprint to operate on.
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to retrieve the permissions of a blueprint.<br/><br/>To learn more about permissions, check
      out the [documentation](https://docs.port.io/build-your-software-catalog/set-catalog-rbac/examples).
  - info:
      name: Update a blueprint's permissions
      type: http
    http:
      method: PATCH
      url: '{{baseUrl}}/v1/blueprints/:blueprint_identifier/permissions'
      params:
      - name: blueprint_identifier
        value: ''
        type: path
        description: The identifier of the blueprint to operate on.
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to update the permissions of a blueprint.<br/><br/>To learn more about permissions, check
      out the [documentation](https://docs.port.io/build-your-software-catalog/set-catalog-rbac/examples).
  - info:
      name: Simulate permissions for a user
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/blueprints/:blueprint_identifier/permissions/simulate'
      params:
      - name: blueprint_identifier
        value: ''
        type: path
        description: The identifier of the blueprint to operate on.
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to simulate what permissions a specific user would have for entities in a blueprint.<br/>Provide
      a userIdentifier and operation to see which entities are accessible, or additionally provide an entityIdentifier to
      see detailed permission checks for that specific entity.<br/><br/>To learn more, see the [permission simulator documentation](https://docs.port.io/build-your-software-catalog/set-catalog-rbac#permission-simulator).
  - info:
      name: Get all blueprints
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/blueprints'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to fetch all blueprints in your Port account.<br/><br/>To learn more about blueprints, check
      out the [documentation](https://docs.port.io/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/).
  - info:
      name: Create a blueprint
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/blueprints'
      params:
      - name: create_catalog_page
        value: ''
        type: query
        description: If true, a catalog page will be created for this blueprint
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to create a new blueprint in your data model.<br/><br/>To learn more about blueprints, check
      out the [documentation](https://docs.port.io/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/).
  - info:
      name: Get a blueprint
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/blueprints/:identifier'
      params:
      - name: identifier
        value: ''
        type: path
        description: The unique identifier of the resource you want to operate on.
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to fetch a specific blueprint in your Port account.<br/><br/>To learn more about blueprints,
      check out the [documentation](https://docs.port.io/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/).
  - info:
      name: Change a blueprint
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/v1/blueprints/:identifier'
      params:
      - name: identifier
        value: ''
        type: path
        description: The unique identifier of the resource you want to operate on.
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to change a specific blueprint in your Port account.<br/><br/>To learn more about blueprints,
      check out the [documentation](https://docs.port.io/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/).<br/><br/>**Modifying
      system blueprints** <br/>System blueprints (such as `_team`, `_user`, etc.) are managed by Port and their schemas may
      change over time. It is recommended to use the [PATCH route](https://docs.port.io/api-reference/update-
  - info:
      name: Update a blueprint
      type: http
    http:
      method: PATCH
      url: '{{baseUrl}}/v1/blueprints/:identifier'
      params:
      - name: identifier
        value: ''
        type: path
        description: The unique identifier of the resource you want to operate on.
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to update a specific blueprint in your Port account.<br/><br/>To learn more about blueprints,
      check out the [documentation](https://docs.port.io/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/).
  - info:
      name: Delete a blueprint
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/v1/blueprints/:identifier'
      params:
      - name: delete_actions
        value: ''
        type: query
        description: If `true`, all self-service actions associated with this blueprint will be deleted as well.
      - name: identifier
        value: ''
        type: path
        description: The unique identifier of the resource you want to operate on.
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to delete a specific blueprint in your Port account.<br/><br/>To learn more about blueprints,
      check out the [documentation](https://docs.port.io/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/).<br/><br/>
      **Note:** Before deleting a blueprint, make sure all associated entities have been deleted. Entity deletion may take
      a few seconds to complete, so plan accordingly when using the [**Delete an entity**](https://docs.port.io/api-refer
  - info:
      name: Rename a property in a blueprint
      type: http
    http:
      method: PATCH
      url: '{{baseUrl}}/v1/blueprints/:blueprint_identifier/properties/:property_identifier/rename'
      params:
      - name: blueprint_identifier
        value: ''
        type: path
        description: The identifier of the blueprint you want to change.
      - name: property_identifier
        value: ''
        type: path
        description: The identifier of the property you want to rename.
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to change the identifier of a property in a specific blueprint in your Port account.<br/><br/>To
      learn more about blueprints, check out the [documentation](https://docs.port.io/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/).
  - info:
      name: Rename a blueprint's mirror property
      type: http
    http:
      method: PATCH
      url: '{{baseUrl}}/v1/blueprints/:blueprint_identifier/mirror/:property_identifier/rename'
      params:
      - name: blueprint_identifier
        value: ''
        type: path
        description: The identifier of the blueprint you want to change.
      - name: property_identifier
        value: ''
        type: path
        description: The identifier of the property you want to rename.
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to change the identifier of a mirror property in a specific blueprint in your Port account.<br/><br/>To
      learn more about blueprints, check out the [documentation](https://docs.port.io/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/).
  - info:
      name: Rename a blueprint's relation
      type: http
    http:
      method: PATCH
      url: '{{baseUrl}}/v1/blueprints/:blueprint_identifier/relations/:relation_identifier/rename'
      params:
      - name: blueprint_identifier
        value: ''
        type: path
        description: The identifier of the blueprint you want to change.
      - name: relation_identifier
        value: ''
        type: path
        description: The identifier of the relation you want to rename.
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to change the identifier of a relation in a specific blueprint in your Port account.<br/><br/>To
      learn more about blueprints, check out the [documentation](https://docs.port.io/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/).
- info:
    name: Pages
    type: folder
  items:
  - info:
      name: Get a page's permissions
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/pages/:page_identifier/permissions'
      params:
      - name: page_identifier
        value: ''
        type: path
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to get a specific page's permissions.<br/><br/>To learn more about pages, check out the [documentation](https://docs.port.io/customize-pages-dashboards-and-plugins/page/page-permissions).
  - info:
      name: Update a page's permissions
      type: http
    http:
      method: PATCH
      url: '{{baseUrl}}/v1/pages/:page_identifier/permissions'
      params:
      - name: page_identifier
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to update a specific page’s permissions. <br/><br/>To learn more about pages, check out the
      [documentation](https://docs.port.io/customize-pages-dashboards-and-plugins/page/page-permissions).
  - info:
      name: Get all pages in your portal
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/pages'
      params:
      - name: compact
        value: ''
        type: query
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to get all pages in your portal.<br/><br/>To learn more about pages, checkout the [documentation](https://docs.port.io/customize-pages-dashboards-and-plugins/page/catalog-page).
  - info:
      name: Create pages in your portal
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/pages'
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to create pages in your portal.<br/><br/>To learn more about pages, checkout the [documentation](https://docs.port.io/customize-pages-dashboards-and-plugins/page/catalog-page).
  - info:
      name: Get a page
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/pages/:identifier'
      params:
      - name: identifier
        value: ''
        type: path
        description: The unique identifier of the resource you want to operate on.
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to get a specific page in your portal.<br/><br/>To learn more about pages, checkout the [documentation](https://docs.port.io/customize-pages-dashboards-and-plugins/page/catalog-page).
  - info:
      name: Patch a page
      type: http
    http:
      method: PATCH
      url: '{{baseUrl}}/v1/pages/:identifier'
      params:
      - name: identifier
        value: ''
        type: path
        description: The unique identifier of the resource you want to operate on.
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to update a specific page in your portal.<br/><br/>To learn more about pages, checkout the
      [documentation](https://docs.port.io/customize-pages-dashboards-and-plugins/page/catalog-page).
  - info:
      name: Delete a page
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/v1/pages/:identifier'
      params:
      - name: identifier
        value: ''
        type: path
        description: The unique identifier of the resource you want to operate on.
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to delete a specific page in your portal.<br/><br/>To learn more about pages, checkout the
      [documentation](https://docs.port.io/customize-pages-dashboards-and-plugins/page/catalog-page).
  - info:
      name: Duplicate a page
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/pages/:identifier/duplicate'
      params:
      - name: identifier
        value: ''
        type: path
        description: The unique identifier of the resource you want to operate on.
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: Creates a copy of an existing page with the same page permissions.
  - info:
      name: Create a widget
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/pages/:page_identifier/widgets'
      params:
      - name: page_identifier
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to create a widget in a specific page in your portal. <br/><br/>To learn more about pages,
      checkout the [documentation](https://docs.port.io/customize-pages-dashboards-and-plugins/page/catalog-page).
  - info:
      name: Update a widget
      type: http
    http:
      method: PATCH
      url: '{{baseUrl}}/v1/pages/:page_identifier/widgets/:widget_id'
      params:
      - name: page_identifier
        value: ''
        type: path
      - name: widget_id
        value: ''
        type: path
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to update a specific widget in your portal. <br/><br/>To learn more about pages, checkout
      the [documentation](https://docs.port.io/customize-pages-dashboards-and-plugins/page/catalog-page).
  - info:
      name: Delete a widget
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/v1/pages/:page_identifier/widgets/:widget_id'
      params:
      - name: page_identifier
        value: ''
        type: path
      - name: widget_id
        value: ''
        type: path
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to delete a specific widget in your portal. <br/><br/>To learn more about pages, checkout
      the [documentation](https://docs.port.io/customize-pages-dashboards-and-plugins/page/catalog-page).
- info:
    name: Authentication / Authorization
    type: folder
  items:
  - info:
      name: Create an access token
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/auth/access_token'
      body:
        type: json
        data: '{}'
    docs: This route allows you to create an access token for your Port account. You can use this token to authenticate your
      requests to the Port API.<br/><br/>To obtain your client ID and client secret, go to your [Port application](https://app.getport.io),
      click on the `...` button in the top right corner, then click `Credentials`.
  - info:
      name: Rotate a user's credentials
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/rotate-credentials/:user_email'
      params:
      - name: user_email
        value: ''
        type: path
        description: The email address of the user you want to operate on.
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to rotate a user's credentials and generate new ones.
- info:
    name: Entities
    type: folder
  items:
  - info:
      name: Get all entities of a blueprint
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/blueprints/:blueprint_identifier/entities'
      params:
      - name: exclude_calculated_properties
        value: ''
        type: query
        description: If `true`, [calculated properties](https://docs.getport.io/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/calculation-property/)
          will be excluded from the entities.
      - name: include
        value: ''
        type: query
        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 returned in the response.<br/>For example: `{ "properties.propertyIdentifier","identifier"}`.'
      - name: exclude
        value: ''
        type: query
        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 response.<br/>For example: `{ "properties.propertyIdentifier","identifier"}`'
      - name: attach_title_to_relation
        value: ''
        type: query
      - name: attach_identifier_to_title_mirror_properties
        value: ''
        type: query
      - name: allow_partial_results
        value: ''
        type: query
        description: When enabled allows some of the blueprint searches to fail without failing the full request.
      - name: blueprint_identifier
        value: ''
        type: path
        description: The identifier of the blueprint to operate on.
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to fetch all entities in your software catalog based on a given blueprint.<br/><br/>To learn
      more about entities, check out the [documentation](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#entities).
  - info:
      name: Create an entity
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/blueprints/:blueprint_identifier/entities'
      params:
      - name: upsert
        value: ''
        type: query
        description: If `true`, this call will override the entire entity/ies, if it/they already exist/s.
      - name: validation_only
        value: ''
        type: query
        description: If `true`, this call will only validate the entity/ies and return the validation errors.
      - name: create_missing_related_entities
        value: ''
        type: query
        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 you want to create an entity whose related entity does not
          exist yet.
      - name: merge
        value: ''
        type: query
        description: If `true` and `upsert` is also `true`, this call will update the entity/ies, if it/they already exist/s.
      - name: run_id
        value: ''
        type: query
        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-progress/#tying-entities-to-an-action-run).
      - name: ocean_info_resync_id
        value: ''
        type: query
        description: Resync run identifier. Only valid when `ocean_info_event_type` is `resync`.
      - name: ocean_info_event_type
        value: ''
        type: query
        description: How the operation was triggered.
      - name: blueprint_identifier
        value: ''
        type: path
        description: The identifier of the blueprint to operate on.
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to create an entity in your software catalog based on an existing blueprint in your data model.
      It can also be used to overwrite or update an existing entity.<br/><br/>To learn more about entities, check out the
      [documentation](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#entities).
  - info:
      name: Create multiple entities
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/v1/blueprints/:blueprint_identifier/entities/bulk'
      params:
      - name: upsert
        value: ''
        type: query
        description: If `true`, this call will override the entire entity/ies, if it/they already exist/s.
      - name: validation_only
        value: ''
        type: query
        description: If `true`, this call will only validate the entity/ies and return the validation errors.
      - name: create_missing_related_entities
        value: ''
        type: query
        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 you want to create an entity whose related entity does not
          exist yet.
      - name: merge
        value: ''
        type: query
        description: If `true` and `upsert` is also `true`, this call will update the entity/ies, if it/they already exist/s.
      - name: run_id
        value: ''
        type: query
        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-progress/#tying-entities-to-an-action-run).
      - name: ocean_info_resync_id
        value: ''
        type: query
        description: Resync run identifier. Only valid when `ocean_info_event_type` is `resync`.
      - name: ocean_info_event_type
        value: ''
        type: query
        description: How the operation was triggered.
      - name: blueprint_identifier
        value: ''
        type: path
        description: The identifier of the blueprint to operate on.
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to create multiple entities (No more than 20 entities per request) in your software catalog
      based on an existing blueprint in your data model. It can also be used to overwrite or update existing entities.<br/><br/>To
      learn more about entities, check out the [documentation](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#entities).<br/><br/>
      **Note:** A failure response does not necessarily mean that all entities failed. A `207 Multi-Status` response i
  - info:
      name: Get an entity
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/blueprints/:blueprint_identifier/entities/:entity_identifier'
      params:
      - name: exclude_calculated_properties
        value: ''
        type: query
        description: If `true`, [calculated properties](https://docs.getport.io/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/calculation-property/)
          will be excluded from the entities.
      - name: include
        value: ''
        type: query
        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 returned in the response.<br/>For example: `{ "properties.propertyIdentifier","identifier"}`.'
      - name: exclude
        value: ''
        type: query
        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 response.<br/>For example: `{ "properties.propertyIdentifier","identifier"}`'
      - name: attach_title_to_relation
        value: ''
        type: query
      - name: attach_identifier_to_title_mirror_properties
        value: ''
        type: query
      - name: allow_partial_results
        value: ''
        type: query
        description: When enabled allows some of the blueprint searches to fail without failing the full request.
      - name: entity_identifier
        value: ''
        type: path
        description: The identifier of the entity to operate on.
      - name: blueprint_identifier
        value: ''
        type: path
        description: The identifier of the blueprint to operate on.
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to fetch a specific entity in your software catalog.<br/><br/>To learn more about entities,
      check out the [documentation](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#entities).
  - info:
      name: Change an entity
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/v1/blueprints/:blueprint_identifier/entities/:entity_identifier'
      params:
      - name: create_missing_related_entities
        value: ''
        type: query
        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 you want to create an entity whose related entity does not
          exist yet.
      - name: run_id
        value: ''
        type: query
        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-progress/#tying-entities-to-an-action-run).
      - name: ocean_info_resync_id
        value: ''
        type: query
        description: Resync run identifier. Only valid when `ocean_info_event_type` is `resync`.
      - name: ocean_info_event_type
        value: ''
        type: query
        description: How the operation was triggered.
      - name: entity_identifier
        value: ''
        type: path
        description: The identifier of the entity to operate on.
      - name: blueprint_identifier
        value: ''
        type: path
        description: The identifier of the blueprint to operate on.
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to edit a specific entity in your software catalog and update its properties.<br/><br/>To
      learn more about entities, check out the [documentation](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#entities).
  - info:
      name: Update an entity
      type: http
    http:
      method: PATCH
      url: '{{baseUrl}}/v1/blueprints/:blueprint_identifier/entities/:entity_identifier'
      params:
      - name: create_missing_related_entities
        value: ''
        type: query
        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 you want to create an entity whose related entity does not
          exist yet.
      - name: run_id
        value: ''
        type: query
        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-progress/#tying-entities-to-an-action-run).
      - name: ocean_info_resync_id
        value: ''
        type: query
        description: Resync run identifier. Only valid when `ocean_info_event_type` is `resync`.
      - name: ocean_info_event_type
        value: ''
        type: query
        description: How the operation was triggered.
      - name: entity_identifier
        value: ''
        type: path
        description: The identifier of the entity to operate on.
      - name: blueprint_identifier
        value: ''
        type: path
        description: The identifier of the blueprint to operate on.
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to edit a specific entity in your software catalog and update its properties.<br/><br/>To
      learn more about entities, check out the [documentation](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#entities).
  - info:
      name: Delete an entity
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/v1/blueprints/:blueprint_identifier/entities/:entity_identifier'
      params:
      - name: delete_dependents
        value: ''
        type: query
        description: If `true`, this call will also delete all entities with a relation to the deleted entity.
      - name: run_id
        value: ''
        type: query
        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-progress/#tying-entities-to-an-action-run).
      - name: ocean_info_resync_id
        value: ''
        type: query
        description: Resync run identifier. Only valid when `ocean_info_event_type` is `resync`.
      - name: ocean_info_event_type
        value: ''
        type: query
        description: How the operation was triggered.
      - name: entity_identifier
        value: ''
        type: path
        description: The identifier of the entity to operate on.
      - name: blueprint_identifier
        value: ''
        type: path
        description: The identifier of the blueprint to operate on.
      auth:
        type: apikey
        key: Authorization
        value: '{{Authorization}}'
        placement: header
    docs: This route allows you to delete a specific entity in your software catalog.<br/><br/>To learn more about entities,
      check out the [documentation](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/#entities).
  - info:
      name: Get a blueprint's entity count
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/v1/blueprints/:blueprint_identifier/entities-count'
      params:
      - name: blueprint_identifier
        value: ''
        type: path
        description: The identifier of the blueprint to operate on.
      auth:
        type: apikey
        key

# --- truncated at 32 KB (96 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/port/refs/heads/main/apis.yml