{"action":"created","comment":{"url":"https://api.github.com/repos/Normation/rudder-api-doc/pulls/comments/25784875","id":25784875,"diff_hunk":"@@ -1,96 +1,100 @@\n # Introduction\n \n-In Rudder 2.7.0, a Rest API was added. This API allows you to interact with Rudder without using the webapp, for example via scripts or cronjobs.\n+Rudder exposes a REST API, enabling the user to interact with Rudder without using the webapp, for example in scripts or cronjobs.\n \n <span id=\"api-_-Authentication\"/>\n ## Authentication\n \n+Authenticating against the API is mandatory for every request, as sensitive information like inventories or configuration rules may get exposed.\n \n-To use the API, you need to be authenticated. Rudder may contain capital information about your IT, and we don't want that information to be public, do we?\n+It is done using a dedicated API Account, than can be created in the web interface on the 'API Accounts' page located inside the Administration part.\n \n-Authentication is done via a dedicated API Account. Those accounts can be created in Rudder, on the 'API Accounts' page located inside the Administration part. API Accounts are not connected to standard user accounts, and are currently global, accessible by admins only.\n+API Accounts are not linked to standard user accounts, and currently give full administrative privileges: They must be secured adequately.\n \n <p><img title=\"Rudder API Settings page\" alt=\"Rudder API page\" src=\"img/APISettings.png\" class=\"RudderImage\"></p>\n \n-Once you have created an API Account, you can now use the API. A token is generated for each account which you will need to authenticate.\n+Once you have created an API account, you get a token that you will need to authenticate on every request. This token is the API equivalent of a password, and must","path":"introduction.md","position":20,"original_position":20,"commit_id":"8e6cb6e6eaffff9442be453f83ebcb0120e6526f","original_commit_id":"8e6cb6e6eaffff9442be453f83ebcb0120e6526f","user":{"login":"fanf","id":44649,"avatar_url":"https://avatars.githubusercontent.com/u/44649?v=3","gravatar_id":"","url":"https://api.github.com/users/fanf","html_url":"https://github.com/fanf","followers_url":"https://api.github.com/users/fanf/followers","following_url":"https://api.github.com/users/fanf/following{/other_user}","gists_url":"https://api.github.com/users/fanf/gists{/gist_id}","starred_url":"https://api.github.com/users/fanf/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/fanf/subscriptions","organizations_url":"https://api.github.com/users/fanf/orgs","repos_url":"https://api.github.com/users/fanf/repos","events_url":"https://api.github.com/users/fanf/events{/privacy}","received_events_url":"https://api.github.com/users/fanf/received_events","type":"User","site_admin":false},"body":"that will be needed to authenticate each request","created_at":"2015-03-04T15:50:40Z","updated_at":"2015-03-04T15:50:40Z","html_url":"https://github.com/Normation/rudder-api-doc/pull/14#discussion_r25784875","pull_request_url":"https://api.github.com/repos/Normation/rudder-api-doc/pulls/14","_links":{"self":{"href":"https://api.github.com/repos/Normation/rudder-api-doc/pulls/comments/25784875"},"html":{"href":"https://github.com/Normation/rudder-api-doc/pull/14#discussion_r25784875"},"pull_request":{"href":"https://api.github.com/repos/Normation/rudder-api-doc/pulls/14"}}},"pull_request":{"url":"https://api.github.com/repos/Normation/rudder-api-doc/pulls/14","id":30091039,"html_url":"https://github.com/Normation/rudder-api-doc/pull/14","diff_url":"https://github.com/Normation/rudder-api-doc/pull/14.diff","patch_url":"https://github.com/Normation/rudder-api-doc/pull/14.patch","issue_url":"https://api.github.com/repos/Normation/rudder-api-doc/issues/14","number":14,"state":"open","locked":false,"title":"Fixes #6303: Improve the API documentation and bump the default version ...","user":{"login":"Kegeruneku","id":917886,"avatar_url":"https://avatars.githubusercontent.com/u/917886?v=3","gravatar_id":"","url":"https://api.github.com/users/Kegeruneku","html_url":"https://github.com/Kegeruneku","followers_url":"https://api.github.com/users/Kegeruneku/followers","following_url":"https://api.github.com/users/Kegeruneku/following{/other_user}","gists_url":"https://api.github.com/users/Kegeruneku/gists{/gist_id}","starred_url":"https://api.github.com/users/Kegeruneku/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Kegeruneku/subscriptions","organizations_url":"https://api.github.com/users/Kegeruneku/orgs","repos_url":"https://api.github.com/users/Kegeruneku/repos","events_url":"https://api.github.com/users/Kegeruneku/events{/privacy}","received_events_url":"https://api.github.com/users/Kegeruneku/received_events","type":"User","site_admin":false},"body":"...to 5\r\n\r\nTicket: http://www.rudder-project.org/redmine/issues/6303","created_at":"2015-02-26T16:13:22Z","updated_at":"2015-03-04T15:50:40Z","closed_at":null,"merged_at":null,"merge_commit_sha":"f8d74c01c103829b062729490a4aba451921dd23","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/Normation/rudder-api-doc/pulls/14/commits","review_comments_url":"https://api.github.com/repos/Normation/rudder-api-doc/pulls/14/comments","review_comment_url":"https://api.github.com/repos/Normation/rudder-api-doc/pulls/comments{/number}","comments_url":"https://api.github.com/repos/Normation/rudder-api-doc/issues/14/comments","statuses_url":"https://api.github.com/repos/Normation/rudder-api-doc/statuses/8e6cb6e6eaffff9442be453f83ebcb0120e6526f","head":{"label":"Kegeruneku:bug_6303/int/6303_bump_latest_api_version_to_5","ref":"bug_6303/int/6303_bump_latest_api_version_to_5","sha":"8e6cb6e6eaffff9442be453f83ebcb0120e6526f","user":{"login":"Kegeruneku","id":917886,"avatar_url":"https://avatars.githubusercontent.com/u/917886?v=3","gravatar_id":"","url":"https://api.github.com/users/Kegeruneku","html_url":"https://github.com/Kegeruneku","followers_url":"https://api.github.com/users/Kegeruneku/followers","following_url":"https://api.github.com/users/Kegeruneku/following{/other_user}","gists_url":"https://api.github.com/users/Kegeruneku/gists{/gist_id}","starred_url":"https://api.github.com/users/Kegeruneku/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Kegeruneku/subscriptions","organizations_url":"https://api.github.com/users/Kegeruneku/orgs","repos_url":"https://api.github.com/users/Kegeruneku/repos","events_url":"https://api.github.com/users/Kegeruneku/events{/privacy}","received_events_url":"https://api.github.com/users/Kegeruneku/received_events","type":"User","site_admin":false},"repo":{"id":31375580,"name":"rudder-api-doc","full_name":"Kegeruneku/rudder-api-doc","owner":{"login":"Kegeruneku","id":917886,"avatar_url":"https://avatars.githubusercontent.com/u/917886?v=3","gravatar_id":"","url":"https://api.github.com/users/Kegeruneku","html_url":"https://github.com/Kegeruneku","followers_url":"https://api.github.com/users/Kegeruneku/followers","following_url":"https://api.github.com/users/Kegeruneku/following{/other_user}","gists_url":"https://api.github.com/users/Kegeruneku/gists{/gist_id}","starred_url":"https://api.github.com/users/Kegeruneku/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Kegeruneku/subscriptions","organizations_url":"https://api.github.com/users/Kegeruneku/orgs","repos_url":"https://api.github.com/users/Kegeruneku/repos","events_url":"https://api.github.com/users/Kegeruneku/events{/privacy}","received_events_url":"https://api.github.com/users/Kegeruneku/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/Kegeruneku/rudder-api-doc","description":"Documentation for the REST APIs of Rudder","fork":true,"url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc","forks_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/forks","keys_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/keys{/key_id}","collaborators_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/teams","hooks_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/hooks","issue_events_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/issues/events{/number}","events_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/events","assignees_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/assignees{/user}","branches_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/branches{/branch}","tags_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/tags","blobs_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/git/refs{/sha}","trees_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/git/trees{/sha}","statuses_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/statuses/{sha}","languages_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/languages","stargazers_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/stargazers","contributors_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/contributors","subscribers_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/subscribers","subscription_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/subscription","commits_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/commits{/sha}","git_commits_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/git/commits{/sha}","comments_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/comments{/number}","issue_comment_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/issues/comments{/number}","contents_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/contents/{+path}","compare_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/compare/{base}...{head}","merges_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/merges","archive_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/downloads","issues_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/issues{/number}","pulls_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/pulls{/number}","milestones_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/milestones{/number}","notifications_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/labels{/name}","releases_url":"https://api.github.com/repos/Kegeruneku/rudder-api-doc/releases{/id}","created_at":"2015-02-26T16:11:01Z","updated_at":"2015-02-26T16:11:01Z","pushed_at":"2015-02-26T16:10:31Z","git_url":"git://github.com/Kegeruneku/rudder-api-doc.git","ssh_url":"git@github.com:Kegeruneku/rudder-api-doc.git","clone_url":"https://github.com/Kegeruneku/rudder-api-doc.git","svn_url":"https://github.com/Kegeruneku/rudder-api-doc","homepage":"http://www.rudder-project.org/rudder-api-doc/","size":913,"stargazers_count":0,"watchers_count":0,"language":"JavaScript","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"Normation:master","ref":"master","sha":"70ece42e7fb3362eb00524c59153976333fc7aaf","user":{"login":"Normation","id":695105,"avatar_url":"https://avatars.githubusercontent.com/u/695105?v=3","gravatar_id":"","url":"https://api.github.com/users/Normation","html_url":"https://github.com/Normation","followers_url":"https://api.github.com/users/Normation/followers","following_url":"https://api.github.com/users/Normation/following{/other_user}","gists_url":"https://api.github.com/users/Normation/gists{/gist_id}","starred_url":"https://api.github.com/users/Normation/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Normation/subscriptions","organizations_url":"https://api.github.com/users/Normation/orgs","repos_url":"https://api.github.com/users/Normation/repos","events_url":"https://api.github.com/users/Normation/events{/privacy}","received_events_url":"https://api.github.com/users/Normation/received_events","type":"Organization","site_admin":false},"repo":{"id":11635535,"name":"rudder-api-doc","full_name":"Normation/rudder-api-doc","owner":{"login":"Normation","id":695105,"avatar_url":"https://avatars.githubusercontent.com/u/695105?v=3","gravatar_id":"","url":"https://api.github.com/users/Normation","html_url":"https://github.com/Normation","followers_url":"https://api.github.com/users/Normation/followers","following_url":"https://api.github.com/users/Normation/following{/other_user}","gists_url":"https://api.github.com/users/Normation/gists{/gist_id}","starred_url":"https://api.github.com/users/Normation/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Normation/subscriptions","organizations_url":"https://api.github.com/users/Normation/orgs","repos_url":"https://api.github.com/users/Normation/repos","events_url":"https://api.github.com/users/Normation/events{/privacy}","received_events_url":"https://api.github.com/users/Normation/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/Normation/rudder-api-doc","description":"Documentation for the REST APIs of Rudder","fork":false,"url":"https://api.github.com/repos/Normation/rudder-api-doc","forks_url":"https://api.github.com/repos/Normation/rudder-api-doc/forks","keys_url":"https://api.github.com/repos/Normation/rudder-api-doc/keys{/key_id}","collaborators_url":"https://api.github.com/repos/Normation/rudder-api-doc/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/Normation/rudder-api-doc/teams","hooks_url":"https://api.github.com/repos/Normation/rudder-api-doc/hooks","issue_events_url":"https://api.github.com/repos/Normation/rudder-api-doc/issues/events{/number}","events_url":"https://api.github.com/repos/Normation/rudder-api-doc/events","assignees_url":"https://api.github.com/repos/Normation/rudder-api-doc/assignees{/user}","branches_url":"https://api.github.com/repos/Normation/rudder-api-doc/branches{/branch}","tags_url":"https://api.github.com/repos/Normation/rudder-api-doc/tags","blobs_url":"https://api.github.com/repos/Normation/rudder-api-doc/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/Normation/rudder-api-doc/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/Normation/rudder-api-doc/git/refs{/sha}","trees_url":"https://api.github.com/repos/Normation/rudder-api-doc/git/trees{/sha}","statuses_url":"https://api.github.com/repos/Normation/rudder-api-doc/statuses/{sha}","languages_url":"https://api.github.com/repos/Normation/rudder-api-doc/languages","stargazers_url":"https://api.github.com/repos/Normation/rudder-api-doc/stargazers","contributors_url":"https://api.github.com/repos/Normation/rudder-api-doc/contributors","subscribers_url":"https://api.github.com/repos/Normation/rudder-api-doc/subscribers","subscription_url":"https://api.github.com/repos/Normation/rudder-api-doc/subscription","commits_url":"https://api.github.com/repos/Normation/rudder-api-doc/commits{/sha}","git_commits_url":"https://api.github.com/repos/Normation/rudder-api-doc/git/commits{/sha}","comments_url":"https://api.github.com/repos/Normation/rudder-api-doc/comments{/number}","issue_comment_url":"https://api.github.com/repos/Normation/rudder-api-doc/issues/comments{/number}","contents_url":"https://api.github.com/repos/Normation/rudder-api-doc/contents/{+path}","compare_url":"https://api.github.com/repos/Normation/rudder-api-doc/compare/{base}...{head}","merges_url":"https://api.github.com/repos/Normation/rudder-api-doc/merges","archive_url":"https://api.github.com/repos/Normation/rudder-api-doc/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/Normation/rudder-api-doc/downloads","issues_url":"https://api.github.com/repos/Normation/rudder-api-doc/issues{/number}","pulls_url":"https://api.github.com/repos/Normation/rudder-api-doc/pulls{/number}","milestones_url":"https://api.github.com/repos/Normation/rudder-api-doc/milestones{/number}","notifications_url":"https://api.github.com/repos/Normation/rudder-api-doc/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/Normation/rudder-api-doc/labels{/name}","releases_url":"https://api.github.com/repos/Normation/rudder-api-doc/releases{/id}","created_at":"2013-07-24T13:36:14Z","updated_at":"2015-03-03T14:25:37Z","pushed_at":"2015-03-03T14:25:37Z","git_url":"git://github.com/Normation/rudder-api-doc.git","ssh_url":"git@github.com:Normation/rudder-api-doc.git","clone_url":"https://github.com/Normation/rudder-api-doc.git","svn_url":"https://github.com/Normation/rudder-api-doc","homepage":"http://www.rudder-project.org/rudder-api-doc/","size":913,"stargazers_count":2,"watchers_count":2,"language":"JavaScript","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":8,"mirror_url":null,"open_issues_count":1,"forks":8,"open_issues":1,"watchers":2,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/Normation/rudder-api-doc/pulls/14"},"html":{"href":"https://github.com/Normation/rudder-api-doc/pull/14"},"issue":{"href":"https://api.github.com/repos/Normation/rudder-api-doc/issues/14"},"comments":{"href":"https://api.github.com/repos/Normation/rudder-api-doc/issues/14/comments"},"review_comments":{"href":"https://api.github.com/repos/Normation/rudder-api-doc/pulls/14/comments"},"review_comment":{"href":"https://api.github.com/repos/Normation/rudder-api-doc/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/Normation/rudder-api-doc/pulls/14/commits"},"statuses":{"href":"https://api.github.com/repos/Normation/rudder-api-doc/statuses/8e6cb6e6eaffff9442be453f83ebcb0120e6526f"}}}}