{"id":924,"date":"2013-05-05T16:25:27","date_gmt":"2013-05-05T16:25:27","guid":{"rendered":"http:\/\/joelinoff.com\/blog\/?p=924"},"modified":"2013-05-05T16:26:54","modified_gmt":"2013-05-05T16:26:54","slug":"count-all-confluence-pages-in-python-using-xml-rpc-api","status":"publish","type":"post","link":"https:\/\/joelinoff.com\/blog\/?p=924","title":{"rendered":"Count all Confluence pages in python using XML-RPC API"},"content":{"rendered":"

I was recently asked how to count the total pages on a 4.2 Confluence server so I provided this python script that shows how to use the XML-RPC API to do it. The technique can be used for more than counting pages. The API provides all sorts of useful operations, like adding users. For more information on the available methods see this page: https:\/\/developer.atlassian.com\/display\/CONFDEV\/Remote+Confluence+Methods<\/a>.
\n
\n[crayon lang=”python” toolbar=”always” title=”confluence_pages”]
\n#!\/usr\/bin\/env python
\nr”’
\nThis script shows how to use the XML-RPC API to access
\ninformation from a Confluence server.<\/p>\n

Here is how you might use it:<\/p>\n

$ confluence_pages.py
\nURL: http:\/\/confluence
\nUsername: myself
\nPassword: <\/p>\n

Server Info
\n baseUrl : http:\/\/confluence:8090
\n buildId : 3284
\n developmentBuild : false
\n majorVersion : 4
\n minorVersion : 2
\n patchLevel : 5<\/p>\n

Misc Info
\n Active Users : 580
\n Spaces : 120
\n Pages : 7260<\/p>\n

”’
\nimport datetime
\nimport getpass
\nimport sys
\nimport xmlrpclib<\/p>\n

def get_credentials():
\n ”’
\n Get the access credentials.<\/p>\n

They are accessed positionally from the command line
\n or from a prompt.<\/p>\n

@returns a tuple of url, username and password
\n ”’
\n url = None
\n username = None
\n password = None<\/p>\n

if len(sys.argv) > 1:
\n url = sys.argv[1]
\n if len(sys.argv) > 2:
\n username = sys.argv[2]
\n if len(sys.argv) > 3:
\n password = sys.argv[3]<\/p>\n

if url is None:
\n url = raw_input(‘URL: ‘) # ex. https:\/\/docs.tabula.com
\n if username is None:
\n username = raw_input(‘Username: ‘) # ex. jlinoff
\n if password is None:
\n password = getpass.getpass(‘Password: ‘)
\n return url, username, password<\/p>\n

def access_confluence(url, username, password):
\n ”’
\n Access confluence and report some information.
\n @param url The URL of the server.
\n @param username Login username.
\n @param password Login password.
\n ”’
\n server = xmlrpclib.ServerProxy(url + ‘\/rpc\/xmlrpc’)
\n token = server.confluence2.login(username, password)<\/p>\n

# Server
\n info = server.confluence2.getServerInfo(token)
\n now = datetime.datetime.now()
\n print
\n print ‘Confluence Pages Report ‘+now.strftime(‘%Y-%m-%d %H:%M:%S’)
\n print
\n print ‘ Server Info’
\n maxlen = 0
\n for item in sorted(info):
\n maxlen = max(len(item), maxlen)
\n for item in sorted(info):
\n val = info[item]
\n print ‘ %-*s : %s’ % (maxlen, item, val)<\/p>\n

# Misc
\n spaces = server.confluence2.getSpaces(token)
\n users = server.confluence2.getActiveUsers(token, True)
\n print
\n print ‘ Misc Info’
\n print ‘ %-12s : %5d’ % (‘Active Users’, len(users))
\n print ‘ %-12s : %5d’ % (‘Spaces’, len(spaces))<\/p>\n

num_pages = 0
\n for space in spaces:
\n space_key = space[‘key’]
\n num_pages += len(server.confluence2.getPages(token, space_key))
\n print ‘ %-12s : %5d’ % (‘Pages’, num_pages)
\n server.confluence2.logout(token)
\n print<\/p>\n

def main():
\n ”’
\n Run program.
\n ”’
\n url, username, password = get_credentials()
\n access_confluence(url, username, password)<\/p>\n

if __name__ == ‘__main__’:
\n main()
\n[\/crayon]
\nNote that this script has very weak option handling and, as such, is not suitable for production.<\/p>\n","protected":false},"excerpt":{"rendered":"

I was recently asked how to count the total pages on a 4.2 Confluence server so I provided this python script that shows how to use the XML-RPC API to do it. The technique can be used for more than counting pages. The API provides all sorts of useful operations, like adding users. For more … Continue reading Count all Confluence pages in python using XML-RPC API<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0},"categories":[7,16],"tags":[],"_links":{"self":[{"href":"https:\/\/joelinoff.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/924"}],"collection":[{"href":"https:\/\/joelinoff.com\/blog\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/joelinoff.com\/blog\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/joelinoff.com\/blog\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/joelinoff.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=924"}],"version-history":[{"count":7,"href":"https:\/\/joelinoff.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/924\/revisions"}],"predecessor-version":[{"id":931,"href":"https:\/\/joelinoff.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/924\/revisions\/931"}],"wp:attachment":[{"href":"https:\/\/joelinoff.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=924"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/joelinoff.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=924"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/joelinoff.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=924"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}