1. Packages
  2. Port
  3. API Docs
  4. getSearch
Port v2.19.6 published on Thursday, Feb 12, 2026 by port-labs
Schema (JSON)
port-labs/pulumi-port

port.getSearch

port logo
Port v2.19.6 published on Thursday, Feb 12, 2026 by port-labs
Schema (JSON)
port-labs/pulumi-port

    Using getSearch

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSearch(args: GetSearchArgs, opts?: InvokeOptions): Promise<GetSearchResult>
function getSearchOutput(args: GetSearchOutputArgs, opts?: InvokeOptions): Output<GetSearchResult>
    def get_search(attach_title_to_relation: Optional[bool] = None,
               exclude_calculated_properties: Optional[bool] = None,
               excludes: Optional[Sequence[str]] = None,
               includes: Optional[Sequence[str]] = None,
               query: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetSearchResult
def get_search_output(attach_title_to_relation: Optional[pulumi.Input[bool]] = None,
               exclude_calculated_properties: Optional[pulumi.Input[bool]] = None,
               excludes: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
               includes: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
               query: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetSearchResult]
    func GetSearch(ctx *Context, args *GetSearchArgs, opts ...InvokeOption) (*GetSearchResult, error)
func GetSearchOutput(ctx *Context, args *GetSearchOutputArgs, opts ...InvokeOption) GetSearchResultOutput

    > Note: This function is named GetSearch in the Go SDK.

    public static class GetSearch 
{
    public static Task<GetSearchResult> InvokeAsync(GetSearchArgs args, InvokeOptions? opts = null)
    public static Output<GetSearchResult> Invoke(GetSearchInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSearchResult> getSearch(GetSearchArgs args, InvokeOptions options)
public static Output<GetSearchResult> getSearch(GetSearchArgs args, InvokeOptions options)

    fn::invoke:
  function: port:index/getSearch:getSearch
  arguments:
    # arguments dictionary

    The following arguments are supported:

    query String
    attachTitleToRelation Boolean
    excludeCalculatedProperties Boolean
    excludes List<String>
    includes List<String>
    query String
    attachTitleToRelation Boolean
    excludeCalculatedProperties Boolean
    excludes List<String>
    includes List<String>

    getSearch Result

    The following output properties are available:

    Supporting Types

    GetSearchEntity

    Blueprint string
    The blueprint identifier the entity relates to
    CreatedAt string
    The creation date of the entity
    CreatedBy string
    The creator of the entity
    Icon string
    The icon of the entity
    Identifier string
    The identifier of the entity
    Properties port_labs.Port.Inputs.GetSearchEntityProperties
    The properties of the entity
    Relations port_labs.Port.Inputs.GetSearchEntityRelations
    The relations of the entity
    RunId string
    The runID of the action run that created the entity
    Scorecards Dictionary<string, port_labs.Port.Inputs.GetSearchEntityScorecards>
    The scorecards of the entity
    Teams List<string>
    The teams the entity belongs to
    Title string
    The title of the entity
    UpdatedAt string
    The last update date of the entity
    UpdatedBy string
    The last updater of the entity
    Blueprint string
    The blueprint identifier the entity relates to
    CreatedAt string
    The creation date of the entity
    CreatedBy string
    The creator of the entity
    Icon string
    The icon of the entity
    Identifier string
    The identifier of the entity
    Properties GetSearchEntityProperties
    The properties of the entity
    Relations GetSearchEntityRelations
    The relations of the entity
    RunId string
    The runID of the action run that created the entity
    Scorecards map[string]GetSearchEntityScorecards
    The scorecards of the entity
    Teams []string
    The teams the entity belongs to
    Title string
    The title of the entity
    UpdatedAt string
    The last update date of the entity
    UpdatedBy string
    The last updater of the entity
    blueprint String
    The blueprint identifier the entity relates to
    createdAt String
    The creation date of the entity
    createdBy String
    The creator of the entity
    icon String
    The icon of the entity
    identifier String
    The identifier of the entity
    properties GetSearchEntityProperties
    The properties of the entity
    relations GetSearchEntityRelations
    The relations of the entity
    runId String
    The runID of the action run that created the entity
    scorecards Map<String,GetSearchEntityScorecards>
    The scorecards of the entity
    teams List<String>
    The teams the entity belongs to
    title String
    The title of the entity
    updatedAt String
    The last update date of the entity
    updatedBy String
    The last updater of the entity
    blueprint string
    The blueprint identifier the entity relates to
    createdAt string
    The creation date of the entity
    createdBy string
    The creator of the entity
    icon string
    The icon of the entity
    identifier string
    The identifier of the entity
    properties GetSearchEntityProperties
    The properties of the entity
    relations GetSearchEntityRelations
    The relations of the entity
    runId string
    The runID of the action run that created the entity
    scorecards {[key: string]: GetSearchEntityScorecards}
    The scorecards of the entity
    teams string[]
    The teams the entity belongs to
    title string
    The title of the entity
    updatedAt string
    The last update date of the entity
    updatedBy string
    The last updater of the entity
    blueprint str
    The blueprint identifier the entity relates to
    created_at str
    The creation date of the entity
    created_by str
    The creator of the entity
    icon str
    The icon of the entity
    identifier str
    The identifier of the entity
    properties GetSearchEntityProperties
    The properties of the entity
    relations GetSearchEntityRelations
    The relations of the entity
    run_id str
    The runID of the action run that created the entity
    scorecards Mapping[str, GetSearchEntityScorecards]
    The scorecards of the entity
    teams Sequence[str]
    The teams the entity belongs to
    title str
    The title of the entity
    updated_at str
    The last update date of the entity
    updated_by str
    The last updater of the entity
    blueprint String
    The blueprint identifier the entity relates to
    createdAt String
    The creation date of the entity
    createdBy String
    The creator of the entity
    icon String
    The icon of the entity
    identifier String
    The identifier of the entity
    properties Property Map
    The properties of the entity
    relations Property Map
    The relations of the entity
    runId String
    The runID of the action run that created the entity
    scorecards Map<Property Map>
    The scorecards of the entity
    teams List<String>
    The teams the entity belongs to
    title String
    The title of the entity
    updatedAt String
    The last update date of the entity
    updatedBy String
    The last updater of the entity

    GetSearchEntityProperties

    ArrayProps port_labs.Port.Inputs.GetSearchEntityPropertiesArrayProps
    The array properties of the entity
    BooleanProps Dictionary<string, bool>
    The bool properties of the entity
    NumberProps Dictionary<string, double>
    The number properties of the entity
    ObjectProps Dictionary<string, string>
    The object properties of the entity
    StringProps Dictionary<string, string>
    The string properties of the entity
    ArrayProps GetSearchEntityPropertiesArrayProps
    The array properties of the entity
    BooleanProps map[string]bool
    The bool properties of the entity
    NumberProps map[string]float64
    The number properties of the entity
    ObjectProps map[string]string
    The object properties of the entity
    StringProps map[string]string
    The string properties of the entity
    arrayProps GetSearchEntityPropertiesArrayProps
    The array properties of the entity
    booleanProps Map<String,Boolean>
    The bool properties of the entity
    numberProps Map<String,Double>
    The number properties of the entity
    objectProps Map<String,String>
    The object properties of the entity
    stringProps Map<String,String>
    The string properties of the entity
    arrayProps GetSearchEntityPropertiesArrayProps
    The array properties of the entity
    booleanProps {[key: string]: boolean}
    The bool properties of the entity
    numberProps {[key: string]: number}
    The number properties of the entity
    objectProps {[key: string]: string}
    The object properties of the entity
    stringProps {[key: string]: string}
    The string properties of the entity
    array_props GetSearchEntityPropertiesArrayProps
    The array properties of the entity
    boolean_props Mapping[str, bool]
    The bool properties of the entity
    number_props Mapping[str, float]
    The number properties of the entity
    object_props Mapping[str, str]
    The object properties of the entity
    string_props Mapping[str, str]
    The string properties of the entity
    arrayProps Property Map
    The array properties of the entity
    booleanProps Map<Boolean>
    The bool properties of the entity
    numberProps Map<Number>
    The number properties of the entity
    objectProps Map<String>
    The object properties of the entity
    stringProps Map<String>
    The string properties of the entity

    GetSearchEntityPropertiesArrayProps

    BooleanItems Dictionary<string, ImmutableArray<bool>>
    NumberItems Dictionary<string, ImmutableArray<double>>
    ObjectItems Dictionary<string, ImmutableArray<string>>
    StringItems Dictionary<string, ImmutableArray<string>>
    BooleanItems map[string][]bool
    NumberItems map[string][]float64
    ObjectItems map[string][]string
    StringItems map[string][]string
    booleanItems Map<String,List<Boolean>>
    numberItems Map<String,List<Double>>
    objectItems Map<String,List<String>>
    stringItems Map<String,List<String>>
    booleanItems {[key: string]: boolean[]}
    numberItems {[key: string]: number[]}
    objectItems {[key: string]: string[]}
    stringItems {[key: string]: string[]}
    boolean_items Mapping[str, Sequence[bool]]
    number_items Mapping[str, Sequence[float]]
    object_items Mapping[str, Sequence[str]]
    string_items Mapping[str, Sequence[str]]
    booleanItems Map<List<Boolean>>
    numberItems Map<List<Number>>
    objectItems Map<List<String>>
    stringItems Map<List<String>>

    GetSearchEntityRelations

    ManyRelations Dictionary<string, ImmutableArray<string>>
    The many relation of the entity
    SingleRelations Dictionary<string, string>
    The single relation of the entity
    ManyRelations map[string][]string
    The many relation of the entity
    SingleRelations map[string]string
    The single relation of the entity
    manyRelations Map<String,List<String>>
    The many relation of the entity
    singleRelations Map<String,String>
    The single relation of the entity
    manyRelations {[key: string]: string[]}
    The many relation of the entity
    singleRelations {[key: string]: string}
    The single relation of the entity
    many_relations Mapping[str, Sequence[str]]
    The many relation of the entity
    single_relations Mapping[str, str]
    The single relation of the entity
    manyRelations Map<List<String>>
    The many relation of the entity
    singleRelations Map<String>
    The single relation of the entity

    GetSearchEntityScorecards

    GetSearchEntityScorecardsRule

    Identifier string
    Level string
    Status string
    Identifier string
    Level string
    Status string
    identifier String
    level String
    status String
    identifier string
    level string
    status string
    identifier String
    level String
    status String

    Package Details

    Repository
    port port-labs/pulumi-port
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the port-labs Terraform Provider.
    port logo
    Port v2.19.6 published on Thursday, Feb 12, 2026 by port-labs
    Schema (JSON)
    port-labs/pulumi-port
      Meet Neo: Your AI Platform Teammate