package.json 2.8 KB

123456789101112131415161718192021
  1. {
  2. "name": "portainer_api",
  3. "version": "1.20.0",
  4. "description": "Portainer_API_is_an_HTTP_API_served_by_Portainer__It_is_used_by_the_Portainer_UI_and_everything_you_can_do_with_the_UI_can_be_done_using_the_HTTP_API_Examples_are_available_at_httpsgist_github_comdeviantony77026d402366b4b43fa5918d41bc42f8You_can_find_out_more_about_Portainer_at__httpportainer_io_httpportainer_io_and_get_some_support_on__Slack_httpportainer_ioslack__AuthenticationMost_of_the_API_endpoints_require_to_be_authenticated_as_well_as_some_level_of_authorization_to_be_used_Portainer_API_uses_JSON_Web_Token_to_manage_authentication_and_thus_requires_you_to_provide_a_token_in_the_Authorization_header_of_each_requestwith_the_Bearer_authentication_mechanism_ExampleBearer_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9_eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInJvbGUiOjEsImV4cCI6MTQ5OTM3NjE1NH0_NJ6vE8FY1WG6jsRQzfMqeatJ4vh2TWAeeYfDhP71YEE_SecurityEach_API_endpoint_has_an_associated_access_policy_it_is_documented_in_the_description_of_each_endpoint_Different_access_policies_are_available_Public_access_Authenticated_access_Restricted_access_Administrator_access_Public_accessNo_authentication_is_required_to_access_the_endpoints_with_this_access_policy__Authenticated_accessAuthentication_is_required_to_access_the_endpoints_with_this_access_policy__Restricted_accessAuthentication_is_required_to_access_the_endpoints_with_this_access_policy_Extra_checks_might_be_added_to_ensure_access_to_the_resource_is_granted__Returned_data_might_also_be_filtered__Administrator_accessAuthentication_as_well_as_an_administrator_role_are_required_to_access_the_endpoints_with_this_access_policy__Execute_Docker_requestsPortainer_DO_NOT_expose_specific_endpoints_to_manage_your_Docker_resources__create_a_container_remove_a_volume_etc____Instead_it_acts_as_a_reverse_proxy_to_the_Docker_HTTP_API__This_means_that_you_can_execute_Docker_requests_via_the_Portainer_HTTP_API_To_do_so_you_can_use_the_endpointsiddocker_Portainer_API_endpoint__which_is_not_documented_below_due_to_Swagger_limitations__This_endpoint_has_a_restricted_access_policy_so_you_still_need_to_be_authenticated_to_be_able_to_query_this_endpoint__Any_query_on_this_endpoint_will_be_proxied_to_the_Docker_API_of_the_associated_endpoint__requests_and_responses_objects_are_the_same_as_documented_in_the_Docker_API_NOTE_You_can_find_more_information_on_how_to_query_the_Docker_API_in_the__Docker_official_documentation_httpsdocs_docker_comengineapiv1_30_as_well_as_in__this_Portainer_example_httpsgist_github_comdeviantony77026d402366b4b43fa5918d41bc42f8_",
  5. "license": "Unlicense",
  6. "main": "src/index.js",
  7. "scripts": {
  8. "test": "./node_modules/mocha/bin/mocha --recursive"
  9. },
  10. "browser": {
  11. "fs": false
  12. },
  13. "dependencies": {
  14. "superagent": "3.7.0"
  15. },
  16. "devDependencies": {
  17. "mocha": "~2.3.4",
  18. "sinon": "1.17.3",
  19. "expect.js": "~0.3.1"
  20. }
  21. }