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 https //test atlassian net/wiki/spaces/test/pages/123456/test+title+page would have the id 123456 documentation atlassian confluence v1 https //developer atlassian com/cloud/confluence/rest/v1/intro/#authatlassian confluence v2 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 spaceid string required unique identifier status string optional status value title string optional parameter for create blog post body object optional request body data representation string optional parameter for create blog post value string optional value for the parameter private boolean optional parameter for create blog post 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 number number output field number message string response message minoredit boolean output field minoredit authorid string unique identifier createdat string output field createdat title string output field title status string status value body object request body data storage object output field storage value string value for the parameter representation string output field representation spaceid string unique identifier links object output field links editui string output field editui webui string output field webui tinyui string output field tinyui 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 fraction\\" 0 001, \\"include subdomains\\" true, \\"max age\\" 600, \\"report ", "strict transport security" "max age=63072000; includesubdomains; preload", "transfer encoding" "chunked" }, "reason" "ok", "json body" { "createdat" null, "authorid" null, "id" "2792292382", "version" {}, "title" "created draft version blogpost", "status" "draft", "body" {}, "spaceid" "2792259620", " links" {} } } ] create page creates a page in the space endpoint url /wiki/api/v2/pages method post input argument name type required description spaceid string required 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 representation string optional parameter for create page value string optional value for the parameter embedded boolean optional parameter for create page private boolean optional parameter for create page 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 number number output field number message string response message minoredit boolean output field minoredit authorid string unique identifier createdat string output field createdat position number output field position title string output field title status string status value body object request body data storage object output field storage value string value for the parameter representation string output field representation parentid string unique identifier spaceid string unique identifier ownerid object unique identifier lastownerid object unique identifier links object output field links editui string output field editui 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 fraction\\" 0 001, \\"include subdomains\\" true, \\"max age\\" 600, \\"report ", "strict transport security" "max age=63072000; includesubdomains; preload", "transfer encoding" "chunked" }, "reason" "ok", "json body" { "parenttype" "page", "createdat" null, "authorid" null, "id" "2792161373", "version" {}, "position" 341, "title" "created draft page version", "status" "draft", "body" {}, "parentid" "2792259788", "spaceid" "2792259620", "ownerid" null, "lastownerid" null, " links" {} } } ] 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 required parameter for create space name string required name of the resource description object optional parameter for create space plain object required parameter for create space value string optional value for the parameter representation string optional parameter for create space permissions array optional parameter for create space subjects object optional parameter for create space user object optional parameter for create space results array required result of the operation size number required parameter for create space group object optional parameter for create space results array required result of the operation size number required parameter for create space operation object required parameter for create space operation string optional parameter for create space targettype string optional type of the resource anonymousaccess boolean required parameter for create space unlicensedaccess boolean required parameter for create space 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 plain object output field plain value string value for the parameter representation string output field representation embeddedcontent array response content file name string name of the resource file string output field file expandable object output field expandable view string output field view homepage object output field homepage id string unique identifier type string type of the resource status string status value title string output field title paywallstatus string status value macrorenderedoutput object output field macrorenderedoutput extensions object output field extensions position number output field position expandable object output field expandable container string output field container 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\\" \[{\\"url\\" \\"https //dz8aopenkvv6s cloudfront net\\"}], \\"group\\" \\"endpo ", "nel" "{\\"failure fraction\\" 0 001, \\"include subdomains\\" true, \\"max age\\" 600, \\"report ", "strict transport security" "max age=63072000; includesubdomains; preload", "transfer encoding" "chunked" }, "reason" "ok", "json body" { "id" 2792259620, "key" "newspace", "name" "example space test", "description" {}, "homepage" {}, "type" "global", "permissions" \[], "status" "current", " expandable" {}, " links" {} } } ] get attachments get attachments using content id input argument name type required description id string required unique identifier output parameter type description file array file 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 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 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 start number optional parameter for get groups limit number optional parameter for get groups accesstype string optional type of the resource output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation type string type of the resource name string name of the resource id string unique identifier links object output field links self string output field self start number output field start limit number output field limit size number output field size links object output field links base string output field base context string output field context self string output field self 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" "max age=63072000; includesubdomains; preload", "transfer encoding" "chunked" }, "reason" "ok", "json body" { "results" \[], "start" 0, "limit" 200, "size" 35, " links" {} } } ] 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 accountid string required unique identifier expand array optional parameter for get user 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 path string output field path width number unique identifier height number output field height isdefault boolean output field isdefault displayname string name of the resource operations array output field operations operation string output field operation targettype string type of the resource isexternalcollaborator boolean output field isexternalcollaborator expandable object output field expandable personalspace string output field personalspace links object output field links self string output field self base string output field base context string output field context 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\\" \[{\\"url\\" \\"https //dz8aopenkvv6s cloudfront net\\"}], \\"group\\" \\"endpo ", "nel" "{\\"failure fraction\\" 0 001, \\"include subdomains\\" true, \\"max age\\" 600, \\"report ", "strict transport security" "max age=63072000; includesubdomains; preload", "transfer encoding" "chunked" }, "reason" "ok", "json body" { "type" "known", "accountid" "712020 12fb47c4 3e17 45cd a8ec d812a9d52254", "accounttype" "atlassian", "email" "x y\@swimlane com", "publicname" "vc", "profilepicture" {}, "displayname" "vc", "operations" \[], "isexternalcollaborator" false, " expandable" {}, " links" {} } } ] 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 cql string optional the cql string that is used to find the requested content cqlcontext string optional the space, content, and content status to execute the search against expand array optional a multi value parameter indicating which properties of the content to expand cursor string optional pointer to a set of search results, returned as part of the next or prev url from the previous search call limit number optional parameter for search content output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation file name string name of the resource file string output field file start number output field start limit number output field limit size number output field size links object output field links base string output field base context string output field context self string output field self 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" "max age=63072000; includesubdomains; preload", "transfer encoding" "chunked" }, "reason" "ok", "json body" { "results" \[], "start" 0, "limit" 25, "size" 0, " links" {} } } ] 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 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 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 f7c862a2b0564efbafe5b24fae0852ca 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 16 40 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 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