Get-DifyApp¶
Warning
This help was primarily created by a generative AI. It may contain partially inaccurate expressions.
SYNOPSIS¶
Retrieve app information from Dify.
SYNTAX¶
Get-DifyApp [[-Id] <String>] [[-Name] <String>] [[-Search] <String>] [[-Mode] <String>] [[-Tags] <String[]>]
[-Detail] [<CommonParameters>]
DESCRIPTION¶
The Get-DifyApp cmdlet allows you to retrieve app information from Dify. You can filter the results by specifying an app ID, name, search term, mode, or tags.
NOTE: This help was primarily created by a generative AI. It may contain partially inaccurate expressions.
EXAMPLES¶
Example 1¶
Get all apps.
Example 2¶
Get apps by ID.
Example 3¶
Get apps by name with complete match.
Example 4¶
Get apps by name with partial match.
Example 5¶
Get apps by mode.
Example 6¶
Get apps by tags, multiple tags can be specified.
Example 7¶
Combine filters to get apps by name and mode.
Example 8¶
Get all apps with detailed information including WebApp (Site) and API settings. This requires an additional API request per app.
Example 9¶
Get a specific app with detailed information.
PARAMETERS¶
-Detail¶
When specified, retrieves detailed information for each app by making an additional API request per app. The returned objects include additional fields for the app icon, WebApp (Site) configuration, API access status, and related URLs.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Id¶
The unique identifier of the app to retrieve.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Mode¶
The mode of the app to retrieve. Valid values are "chat", "workflow", "agent-chat", "channel", and "all".
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name¶
The name of the app to retrieve (exact match).
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Search¶
A partial name or search term to filter apps.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Tags¶
A list of tags to filter apps by.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.