Request

Make a request to Confluence.

Task version: 1.1.0

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Crossplatform

Source code: https://github.com/FrendsPlatform/Frends.Confluence/tree/main/Frends.Confluence.Request

Task Parameters

Input

Name	Description
Username : String	Username used to connect to confluence with Basic Auth. Default: - Example: [e-mail]
🗝ApiToken : String	ApiToken used to connect to confluence with Basic Auth. Default: - Example: AKxDuOPvOWAb2g1-HtJmeqnlcztevlXMqDGtsNURL88=2C9A9D12
HttpMethod : HttpMethod	Define method of request. Possible values: GET: Define method of request. POST: Define method of request. PUT: Define method of request. PATCH: Define method of request. DELETE: Define method of request. Default: - Example: HttpMethod.Get
ApiVersion : ApiVersion	Api version that will be used in a request. Possible values: V1: Api version that will be used in a request. V2: Api version that will be used in a request. Default: - Example: ApiVersion.V1
ConfluenceDomainName : String	Confluence name Default: - Example: example-name
OperationSufix : String	Url suffix from of operation. All operations are described in Confluence Rest API documentation. Default: - Example: /audit/export
JsonBody : String	Body content of a request if needed in a JSON format. Default: - Example: {"title": "New Page", "status": "current"}
QueryParameters : Dictionary<String, String>	Query parameters from which query string will be constructed. Default: - Example: { {page, 1}, {limit, 5} }

Options

Name	Description
ThrowErrorOnFailure : Boolean	Whether to throw an error on failure. Default: True Example: true
ErrorMessageOnFailure : String	Overrides the error message on failure. Default: - Example: Confluence request failed: invalid credentials

Task Result

Name	Description
Success : Boolean	Indicates whether the operation completed successfully. Example: true
Error : Error	Error details. Null when Success is true. Example: null
Error.Message : String	Error message describing the failure. Example: Request to Confluence API failed with status 401
Error.AdditionalInfo : Exception	Additional information about the error, typically the original exception. Example: null
StatusCode : Int32	Returned status code. Example: 200
Content : Object	Body of the response represented as JToken. Example: { "id": 123 }

Task Changelog

Changelog for Task Frends.Confluence.Request.

[1.1.0] - 2026-08-20

Changed

• Added a required Options parameter to the Request method for controlling error handling behavior.
• Upgraded target framework from .NET 6 to .NET 8.
• The Result object now includes Success and Error properties for improved error handling.

[1.0.0] - 2024-05-21

Added

• Initial implementation of Frends.Confluence.Request.