Search Blueprint Entities - BlinkOps Documentation

Search for blueprint entities in your software catalog based on a set of rules.

External DocumentationTo learn more, visit the Port documentation.

Parameters

Parameter	Description
Blueprint Identifier	The ID of the blueprint to search entities for.
Exclude	A comma-separated list of properties to exclude from the response. Note: To use `Meta-properties` - the `$` prefix must be included (e.g. `$createdAt`, `$updatedAt`).
From	The token to use for pagination. Can be obtained from the `next` property from a previous response.
Include	A comma-separated list of properties to include in the response. Note: To use `Meta-properties` - the `$` prefix must be included (e.g. `$createdAt`, `$updatedAt`).
Limit	The maximum number of entities to return in the response. Valid range is `1` to `1000`.
Query Combinator	The combinator to apply to the search rules.
Return All Pages	Automatically fetch all resources, page by page.
Rules	A 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 Query	Select 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": {}
		}
	]
}