Skip to main content
Search for blueprint entities in your software catalog based on a set of rules.
External DocumentationTo learn more, visit the Port documentation.

​
Parameters

ParameterDescription
Blueprint IdentifierThe ID of the blueprint to search entities for.
ExcludeA comma-separated list of properties to exclude from the response.

Note: To use Meta-properties - the $ prefix must be included (e.g. $createdAt, $updatedAt).
FromThe token to use for pagination. Can be obtained from the next property from a previous response.
IncludeA comma-separated list of properties to include in the response.

Note: To use Meta-properties - the $ prefix must be included (e.g. $createdAt, $updatedAt).
LimitThe maximum number of entities to return in the response. Valid range is 1 to 1000.
Query CombinatorThe combinator to apply to the search rules.
Return All PagesAutomatically fetch all resources, page by page.
RulesA list of search rules to apply to the blueprint entities.

For example:
[
      {
        “property”: “$blueprint”,
        “operator”: ”=”,
        “value”: “service”
      },
      {
        “combinator”: “or”,
        “rules”: [
          {
            “property”: “environment”,
            “operator”: ”=”,
            “value”: “production”
          },
          {
            “property”: “environment”,
            “operator”: ”=”,
            “value”: “staging”
          }
        ]
      }
    ]
Use QuerySelect to use the query parameters (rules and combinator).

​
Example Output

{
	"ok": true,
	"next": "string",
	"entities": [
		{
			"identifier": "string",
			"title": "string",
			"icon": "string",
			"team": "string",
			"properties": {},
			"relations": {}
		}
	]
}

​
Workflow Library Example

Search Blueprint Entities with Port and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop