Atlassian Confluence

use this connector to interact with atlassian's confluence asset setup and capabilities the atlassian confluence connector provides the following capabilities 'confluence authentication' for the following actions which require a url, username, and password for authentication get attachments get content id update page 'api key authentication' is added for the following actions which require url, email, and api token for authentication create blog post create page create space get groups get user search content additional information about capabilities update page the content id for a given page can be found in its url for example, the url https //test atlassian net/wiki/spaces/test/pages/123456/test+title+page would have the id 123456 documentation https //developer atlassian com/cloud/confluence/rest/v1/intro/#auth https //developer atlassian com/cloud/confluence/rest/v2/intro/#about configurations confluence authentication confluence authentication configuration parameters parameter description type required url a url to the target host string required username confluence username string required password confluence password string required api key authentication authenticates using email and api token configuration parameters parameter description type required url domain url string required username atlassian account email string required password api token string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions create blog post creates a new blog post in the space specified by the space id endpoint url /wiki/api/v2/blogposts method post input argument name type required description parameters private boolean optional parameters for the create blog post action spaceid string optional unique identifier status string optional status value title string optional parameter for create blog post body object optional request body data body representation string optional request body data body value string optional request body data input example {"parameters" {"private"\ false},"json body" {"spaceid" "\<string>","status" "current","title" "\<string>","body" {"representation" "storage","value" "\<string>"}}} output parameter type description status code number http status code of the response reason string response reason phrase createdat object output field createdat authorid object unique identifier id string unique identifier version object output field version version number number output field version number version message string response message version minoredit boolean output field version minoredit version authorid string unique identifier version createdat string output field version createdat title string output field title status string status value body object request body data body storage object request body data body storage value string request body data body storage representation string request body data spaceid string unique identifier links object output field links links editui string output field links editui links webui string output field links webui links tinyui string output field links tinyui output example {"status code" 200,"response headers" {"date" "thu, 14 dec 2023 16 18 09 gmt","content type" "application/json","server" "atlassianedge","atl confluence via" "h\ confluence prod us 6 2 prod atl paas net","vary" "accept encoding","content encoding" "gzip","x content type options" "nosniff","x xss protection" "1; mode=block","atl traceid" "64f99be3ed614495b6d44c252f042627","report to" "{\\"endpoints\\" \[{\\"url\\" \\"https //dz8aopenkvv6s cloudfront net\\"}], \\"group\\" \\"endpo ","nel" "{\\"failure fr create page creates a page in the space endpoint url /wiki/api/v2/pages method post input argument name type required description parameters embedded boolean optional parameters for the create page action parameters private boolean optional parameters for the create page action spaceid string optional unique identifier status string optional status value title string optional parameter for create page parentid string optional unique identifier body object optional request body data body representation string optional request body data body value string optional request body data input example {"parameters" {"embedded"\ false,"private"\ false},"json body" {"spaceid" "\<string>","status" "current","title" "\<string>","parentid" "\<string>","body" {"representation" "string","value" "\<string>"}}} output parameter type description status code number http status code of the response reason string response reason phrase parenttype string type of the resource createdat object output field createdat authorid object unique identifier id string unique identifier version object output field version version number number output field version number version message string response message version minoredit boolean output field version minoredit version authorid string unique identifier version createdat string output field version createdat position number output field position title string output field title status string status value body object request body data body storage object request body data body storage value string request body data body storage representation string request body data parentid string unique identifier spaceid string unique identifier ownerid object unique identifier lastownerid object unique identifier links object output field links links editui string output field links editui output example {"status code" 200,"response headers" {"date" "thu, 14 dec 2023 16 16 40 gmt","content type" "application/json","server" "atlassianedge","atl confluence via" "h\ confluence prod us 6 2 prod atl paas net","vary" "accept encoding","content encoding" "gzip","x content type options" "nosniff","x xss protection" "1; mode=block","atl traceid" "b3e2d97a95f54c6192456147ba75d15e","report to" "{\\"endpoints\\" \[{\\"url\\" \\"https //dz8aopenkvv6s cloudfront net\\"}], \\"group\\" \\"endpo ","nel" "{\\"failure fr create space creates a new space note, currently you cannot set space labels when creating a space endpoint url /wiki/rest/api/space method post input argument name type required description key string optional parameter for create space name string optional name of the resource description object optional parameter for create space description plain object required parameter for create space description plain value string optional value for the parameter description plain representation string optional parameter for create space permissions array optional parameter for create space permissions subjects object optional parameter for create space permissions subjects user object optional parameter for create space permissions subjects user results array required result of the operation permissions subjects user results type string required type of the resource permissions subjects user results username string optional name of the resource permissions subjects user results userkey string optional result of the operation permissions subjects user results accountid string optional unique identifier permissions subjects user results accounttype string optional type of the resource permissions subjects user results email string optional result of the operation permissions subjects user results publicname string optional name of the resource permissions subjects user results profilepicture object optional result of the operation permissions subjects user results displayname string optional name of the resource permissions subjects user results timezone string optional result of the operation permissions subjects user results isexternalcollaborator boolean optional result of the operation permissions subjects user results externalcollaborator boolean optional result of the operation permissions subjects user results operations array optional result of the operation permissions subjects user results details object optional result of the operation permissions subjects user results personalspace object optional result of the operation input example {"json body" {"key" "\<string>","name" "\<string>","description" {"plain" {"value" "\<string>","representation" "\<string>"}},"permissions" \[{"subjects" {"user" {"results" \[{"type" "known","username" "\<string>","userkey" "\<string>","accountid" "\<string>","accounttype" "atlassian","email" "\<string>","publicname" "\<string>","profilepicture" {"path" "\<string>","width" 2154,"height" 2154,"isdefault"\ true},"displayname" "\<string>","timezone" "\<string>","isexternalcollaborator"\ true,"externalcollaborator"\ true,"operations" \[{"operation" "administer","targettype" "\<string>"}],"details" {},"personalspace" {"key" "\<string>","name" "\<string>","type" "\<string>","status" "\<string>"," expandable" {}," links" {}}," expandable" {"operations" "\<string>","details" "\<string>","personalspace" "\<string>"}," links" {}}],"size" 2154},"group" {"results" \[{"type" "group","name" "\<string>","id" "\<string>"}],"size" 2154}},"operation" {"operation" "administer","targettype" "\<string>"},"anonymousaccess"\ true,"unlicensedaccess"\ true}]}} output parameter type description status code number http status code of the response reason string response reason phrase id number unique identifier key string output field key name string name of the resource description object output field description description plain object output field description plain description plain value string value for the parameter description plain representation string output field description plain representation description plain embeddedcontent array response content description plain embeddedcontent file name string name of the resource description plain embeddedcontent file string response content description expandable object output field description expandable description expandable view string output field description expandable view homepage object output field homepage homepage id string unique identifier homepage type string type of the resource homepage status string status value homepage title string output field homepage title homepage paywallstatus string status value homepage macrorenderedoutput object output field homepage macrorenderedoutput homepage extensions object output field homepage extensions homepage extensions position number output field homepage extensions position homepage expandable object output field homepage expandable homepage expandable container string output field homepage expandable container output example {"status code" 200,"response headers" {"date" "thu, 14 dec 2023 16 13 03 gmt","content type" "application/json","server" "atlassianedge","atl confluence via" "h\ confluence prod us 6 2 prod atl paas net","vary" "accept encoding","cache control" "no cache, no store, must revalidate","expires" "thu, 01 jan 1970 00 00 00 gmt","content encoding" "gzip","x content type options" "nosniff","x xss protection" "1; mode=block","atl traceid" "ed687b10fbc54ec2b114220024502eb4","report to" "{\\"endpoints\\" \[{ get attachments get attachments using content id input argument name type required description id string required unique identifier input example {"id" "2613477397"} output parameter type description file array file output example {"file" {"filename" "example name","file data" "string"}} get content id get content id from a path input argument name type required description space string optional parameter for get content id title string optional parameter for get content id path string optional parameter for get content id input example {"space" "con","title" "this is just a test page","path" "spaces/con/pages/2613477397/this+is+just+a+test+page"} output parameter type description id number unique identifier status code number http status code of the response headers object http headers for the request reason string response reason phrase output example {"id" 2613477397,"status code" 200,"headers"\ null,"reason" "ok"} get groups returns all user groups the returned groups are ordered alphabetically in ascending order by group name endpoint url /wiki/rest/api/group method get input argument name type required description parameters start number optional parameters for the get groups action parameters limit number optional parameters for the get groups action parameters accesstype string optional parameters for the get groups action input example {"parameters" {"start" 0,"limit" 25,"accesstype" "admin"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results type string type of the resource results name string name of the resource results id string unique identifier results links object result of the operation results links self string result of the operation start number output field start limit number output field limit size number output field size links object output field links links base string output field links base links context string output field links context links self string output field links self output example {"status code" 200,"response headers" {"date" "thu, 14 dec 2023 12 08 44 gmt","content type" "application/json","server" "atlassianedge","atl confluence via" "h\ confluence prod us 6 2 prod atl paas net","vary" "accept encoding","cache control" "no cache, no store, must revalidate","expires" "thu, 01 jan 1970 00 00 00 gmt","content encoding" "gzip","x content type options" "nosniff","x xss protection" "1; mode=block","atl traceid" "e5c79806580e49c9bbc3bb29e6df9714","strict transport security" "ma get user returns a user this includes information about the user, such as the display name, account id, profile picture, and more the information returned may be restricted by the user's profile visibility settings endpoint url /wiki/rest/api/user method get input argument name type required description parameters accountid string required parameters for the get user action parameters expand array optional parameters for the get user action input example {"parameters" {"accountid" "712020 12fb47c4 3e17 45cd a8ec d812a9d52254","expand" \["operations","personalspace","isexternalcollaborator"]}} output parameter type description status code number http status code of the response reason string response reason phrase type string type of the resource accountid string unique identifier accounttype string type of the resource email string output field email publicname string name of the resource profilepicture object output field profilepicture profilepicture path string output field profilepicture path profilepicture width number unique identifier profilepicture height number output field profilepicture height profilepicture isdefault boolean output field profilepicture isdefault displayname string name of the resource operations array output field operations operations operation string output field operations operation operations targettype string type of the resource isexternalcollaborator boolean output field isexternalcollaborator expandable object output field expandable expandable personalspace string output field expandable personalspace links object output field links links self string output field links self links base string output field links base links context string output field links context output example {"status code" 200,"response headers" {"date" "thu, 14 dec 2023 16 20 08 gmt","content type" "application/json","server" "atlassianedge","atl confluence via" "h\ confluence prod us 6 2 prod atl paas net","vary" "accept encoding","cache control" "no cache, no store, must revalidate","expires" "thu, 01 jan 1970 00 00 00 gmt","content encoding" "gzip","x content type options" "nosniff","x xss protection" "1; mode=block","atl traceid" "fdaff7943dbd418ba7c8f8d8b1cee3bc","report to" "{\\"endpoints\\" \[{ search content returns the list of content that matches a confluence query language (cql) query endpoint url /wiki/rest/api/content/search method get input argument name type required description parameters cql string optional the cql string that is used to find the requested content parameters cqlcontext string optional the space, content, and content status to execute the search against parameters expand array optional a multi value parameter indicating which properties of the content to expand parameters cursor string optional pointer to a set of search results, returned as part of the next or prev url from the previous search call parameters limit number optional parameters for the search content action input example {"parameters" {"cql" "","cqlcontext" "","expand" \[""],"cursor" "","limit" 25}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results file name string name of the resource results file string result of the operation start number output field start limit number output field limit size number output field size links object output field links links base string output field links base links context string output field links context links self string output field links self output example {"status code" 200,"response headers" {"date" "thu, 14 dec 2023 11 50 02 gmt","content type" "application/json","server" "atlassianedge","atl confluence via" "h\ confluence prod us 6 2 prod atl paas net","vary" "accept encoding","cache control" "no cache, no store, must revalidate","expires" "thu, 01 jan 1970 00 00 00 gmt","content encoding" "gzip","x content type options" "nosniff","x xss protection" "1; mode=block","atl traceid" "f7c862a2b0564efbafe5b24fae0852ca","strict transport security" "ma update page update documents in confluence input argument name type required description title string optional parameter for update page id string required unique identifier content string required response content input example {"title" "another test for the confluence connector","id" "2613411864","content" "updated content"} output parameter type description successful boolean whether the operation was successful status code number http status code of the response headers object http headers for the request reason string response reason phrase output example {"successful"\ true,"status code" 200,"headers"\ null,"reason" "ok"} response headers header description example atl confluence via http response header atl confluence via h \ confluence prod us 6 2 prod atl paas net atl traceid http response header atl traceid e5c79806580e49c9bbc3bb29e6df9714 cache control directives for caching mechanisms no cache, no store, must revalidate content encoding http response header content encoding gzip content type the media type of the resource application/json date the date and time at which the message was originated thu, 14 dec 2023 16 13 03 gmt expires the date/time after which the response is considered stale thu, 01 jan 1970 00 00 00 gmt nel http response header nel {"failure fraction" 0 001, "include subdomains" true, "max age" 600, "report to" "endpoint 1"} report to http response header report to {"endpoints" \[{"url" " https //dz8aopenkvv6s cloudfront net "}], "group" "endpoint 1", "include subdomains" true, "max age" 600} server information about the software used by the origin server atlassianedge strict transport security http response header strict transport security max age=63072000; includesubdomains; preload transfer encoding http response header transfer encoding chunked vary http response header vary accept encoding x content type options http response header x content type options nosniff x xss protection http response header x xss protection 1; mode=block