Catalog auto discovery

Create an auto-discovery invocation

This route allows you to create an auto-discovery invocation.<br></br> To learn more about the auto-discovery feature, see the documentation.

post/v1/ai/entities-auto-discovery

Request

  • Base URL: https://api.port.io
  • URL: https://api.port.io/v1/ai/entities-auto-discovery
  • Auth: API key in header Authorization

Request body

blueprintIdentifierstring required

The identifier of the blueprint to discover entities for.

excludedBlueprintIdentifiersstring[]

The identifiers of the related blueprints to exclude from the discovery context.

descriptionstring

Additional information to guide the auto-discovery search. For example, you can provide a clue that service names end with _service.

autoApproveboolean

When true, automatically accepts all suggestions without requiring manual review. If some suggestions fail to be ingested but at least one succeeds, the invocation is marked completed. If all suggestions fail to ingest, the invocation is marked failed.

waitForEntitiesboolean

When true, the invocation is in a waiting state until either enough entities have been ingested into the related blueprints, or a safety timeout elapses. Thresholds (count and timeout) are configured on the server, not per-request.

Response

Default Response

okboolean required
invocationIdstring required

Changes

No recorded changes to this operation across all 1 revision of this API.