{"id":23391692,"url":"https://github.com/cbnsndwch/portainer-ce-client","last_synced_at":"2026-05-08T04:03:53.074Z","repository":{"id":214807435,"uuid":"737407213","full_name":"cbnsndwch/portainer-ce-client","owner":"cbnsndwch","description":"A Portainer CE API client with Docker API support","archived":false,"fork":false,"pushed_at":"2024-03-18T23:12:09.000Z","size":1310,"stargazers_count":0,"open_issues_count":6,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-13T03:04:43.408Z","etag":null,"topics":["api","axios","containers","docker","infrastructure-as-code","nodejs","portainer","typescript"],"latest_commit_sha":null,"homepage":"https://www.cbnsndwch.io/libs/portainer-ce-client","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cbnsndwch.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-30T23:14:15.000Z","updated_at":"2023-12-31T00:01:25.000Z","dependencies_parsed_at":null,"dependency_job_id":"353d05e2-8aa2-4ea6-8ecb-e239fe1af705","html_url":"https://github.com/cbnsndwch/portainer-ce-client","commit_stats":null,"previous_names":["cbnsndwch/portainer-ce-client"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/cbnsndwch/portainer-ce-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cbnsndwch%2Fportainer-ce-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cbnsndwch%2Fportainer-ce-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cbnsndwch%2Fportainer-ce-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cbnsndwch%2Fportainer-ce-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cbnsndwch","download_url":"https://codeload.github.com/cbnsndwch/portainer-ce-client/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cbnsndwch%2Fportainer-ce-client/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263836729,"owners_count":23517919,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","axios","containers","docker","infrastructure-as-code","nodejs","portainer","typescript"],"created_at":"2024-12-22T04:19:08.656Z","updated_at":"2026-05-08T04:03:52.985Z","avatar_url":"https://github.com/cbnsndwch.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Portainer CE REST API\n\nThe Portainer CE REST 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 \u003chttps://documentation.portainer.io/api/api-examples/\u003e.\n\nYou can find out more about Portainer at [http://portainer.io](http://portainer.io) and get some support on [Slack](http://portainer.io/slack/).\n\n## Authentication\n\nMost of the API environments(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 request with the `Bearer` authentication mechanism.\n\n## Security\n\nEach API endpoint has an associated access policy which is documented in the description of each. Different access policies are available:\n\n- Public access\n- Authenticated access\n- Restricted access\n- Administrator access\n\n### Public access\n\nNo authentication is required to access the environments(endpoints) with this access policy.\n\n### Authenticated access\n\nAuthentication is required to access the environments(endpoints) with this access policy.\n\n### Restricted access\n\nAuthentication is required to access the environments(endpoints) with this access policy. Extra-checks might be added to ensure access to the resource is granted. Returned data might also be filtered.\n\n### Administrator access\n\nAuthentication as well as an administrator role are required to access the environments (endpoints) with this access policy.\n\n## Execute Docker requests\n\nPortainer **DOES 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.\n\nTo do so, you can use the `/endpoints/{id}/docker` path prefix and append the Docker API endpoint path. This endpoint has a restricted access policy so you still need to be authenticated to be able to call it. Any query on this endpoint will be proxied to the Docker API of the associated Portainer environment. Requests and responses objects are the same as documented in the Docker API.\n\nYou can find more information on how to query the Docker API in the [Docker official documentation](https://docs.docker.com/engine/api/v1.30/) as well as in [this Portainer example](https://documentation.portainer.io/api/api-examples/).\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details\n\n## Open Source Licenses\n\nThis project is based in part on the [portainer_api_with_docker_api] package, including some of the contents of this README.md file. `portainer_api_with_docker_api` is licensed under the MIT License.\n\nFor detailed information on additional open source software used in this project, please see the [SBOM](sbom.json) file.\n\n[portainer_api_with_docker_api]: https://www.npmjs.com/package/portainer_api_with_docker_api\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcbnsndwch%2Fportainer-ce-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcbnsndwch%2Fportainer-ce-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcbnsndwch%2Fportainer-ce-client/lists"}