| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200 |
- /**
- * Portainer API
- * 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 https://gist.github.com/deviantony/77026d402366b4b43fa5918d41bc42f8 You can find out more about Portainer at [http://portainer.io](http://portainer.io) and get some support on [Slack](http://portainer.io/slack/). # Authentication Most 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 request with the **Bearer** authentication mechanism. Example: ``` Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInJvbGUiOjEsImV4cCI6MTQ5OTM3NjE1NH0.NJ6vE8FY1WG6jsRQzfMqeatJ4vh2TWAeeYfDhP71YEE ``` # Security Each 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 access No authentication is required to access the endpoints with this access policy. ### Authenticated access Authentication is required to access the endpoints with this access policy. ### Restricted access Authentication 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 access Authentication as well as an administrator role are required to access the endpoints with this access policy. # Execute Docker requests Portainer **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 `/endpoints/{id}/docker` 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](https://docs.docker.com/engine/api/v1.30/) as well as in [this Portainer example](https://gist.github.com/deviantony/77026d402366b4b43fa5918d41bc42f8).
- *
- * OpenAPI spec version: 1.20.0
- * Contact: info@portainer.io
- *
- * NOTE: This class is auto generated by the swagger code generator program.
- * https://github.com/swagger-api/swagger-codegen.git
- *
- * Swagger Codegen version: 2.4.0
- *
- * Do not edit the class manually.
- *
- */
- (function(root, factory) {
- if (typeof define === 'function' && define.amd) {
- // AMD.
- define(['expect.js', '../../src/index'], factory);
- } else if (typeof module === 'object' && module.exports) {
- // CommonJS-like environments that support module.exports, like Node.
- factory(require('expect.js'), require('../../src/index'));
- } else {
- // Browser globals (root is window)
- factory(root.expect, root.PortainerApi);
- }
- }(this, function(expect, PortainerApi) {
- 'use strict';
- var instance;
- beforeEach(function() {
- instance = new PortainerApi.Template();
- });
- var getProperty = function(object, getter, property) {
- // Use getter method if present; otherwise, get the property directly.
- if (typeof object[getter] === 'function')
- return object[getter]();
- else
- return object[property];
- }
- var setProperty = function(object, setter, property, value) {
- // Use setter method if present; otherwise, set the property directly.
- if (typeof object[setter] === 'function')
- object[setter](value);
- else
- object[property] = value;
- }
- describe('Template', function() {
- it('should create an instance of Template', function() {
- // uncomment below and update the code to test Template
- //var instance = new PortainerApi.Template();
- //expect(instance).to.be.a(PortainerApi.Template);
- });
- it('should have the property id (base name: "id")', function() {
- // uncomment below and update the code to test the property id
- //var instance = new PortainerApi.Template();
- //expect(instance).to.be();
- });
- it('should have the property type (base name: "type")', function() {
- // uncomment below and update the code to test the property type
- //var instance = new PortainerApi.Template();
- //expect(instance).to.be();
- });
- it('should have the property title (base name: "title")', function() {
- // uncomment below and update the code to test the property title
- //var instance = new PortainerApi.Template();
- //expect(instance).to.be();
- });
- it('should have the property description (base name: "description")', function() {
- // uncomment below and update the code to test the property description
- //var instance = new PortainerApi.Template();
- //expect(instance).to.be();
- });
- it('should have the property administratorOnly (base name: "administrator_only")', function() {
- // uncomment below and update the code to test the property administratorOnly
- //var instance = new PortainerApi.Template();
- //expect(instance).to.be();
- });
- it('should have the property image (base name: "image")', function() {
- // uncomment below and update the code to test the property image
- //var instance = new PortainerApi.Template();
- //expect(instance).to.be();
- });
- it('should have the property repository (base name: "repository")', function() {
- // uncomment below and update the code to test the property repository
- //var instance = new PortainerApi.Template();
- //expect(instance).to.be();
- });
- it('should have the property name (base name: "name")', function() {
- // uncomment below and update the code to test the property name
- //var instance = new PortainerApi.Template();
- //expect(instance).to.be();
- });
- it('should have the property logo (base name: "logo")', function() {
- // uncomment below and update the code to test the property logo
- //var instance = new PortainerApi.Template();
- //expect(instance).to.be();
- });
- it('should have the property env (base name: "env")', function() {
- // uncomment below and update the code to test the property env
- //var instance = new PortainerApi.Template();
- //expect(instance).to.be();
- });
- it('should have the property note (base name: "note")', function() {
- // uncomment below and update the code to test the property note
- //var instance = new PortainerApi.Template();
- //expect(instance).to.be();
- });
- it('should have the property platform (base name: "platform")', function() {
- // uncomment below and update the code to test the property platform
- //var instance = new PortainerApi.Template();
- //expect(instance).to.be();
- });
- it('should have the property categories (base name: "categories")', function() {
- // uncomment below and update the code to test the property categories
- //var instance = new PortainerApi.Template();
- //expect(instance).to.be();
- });
- it('should have the property registry (base name: "registry")', function() {
- // uncomment below and update the code to test the property registry
- //var instance = new PortainerApi.Template();
- //expect(instance).to.be();
- });
- it('should have the property command (base name: "command")', function() {
- // uncomment below and update the code to test the property command
- //var instance = new PortainerApi.Template();
- //expect(instance).to.be();
- });
- it('should have the property network (base name: "network")', function() {
- // uncomment below and update the code to test the property network
- //var instance = new PortainerApi.Template();
- //expect(instance).to.be();
- });
- it('should have the property volumes (base name: "volumes")', function() {
- // uncomment below and update the code to test the property volumes
- //var instance = new PortainerApi.Template();
- //expect(instance).to.be();
- });
- it('should have the property ports (base name: "ports")', function() {
- // uncomment below and update the code to test the property ports
- //var instance = new PortainerApi.Template();
- //expect(instance).to.be();
- });
- it('should have the property labels (base name: "labels")', function() {
- // uncomment below and update the code to test the property labels
- //var instance = new PortainerApi.Template();
- //expect(instance).to.be();
- });
- it('should have the property privileged (base name: "privileged")', function() {
- // uncomment below and update the code to test the property privileged
- //var instance = new PortainerApi.Template();
- //expect(instance).to.be();
- });
- it('should have the property interactive (base name: "interactive")', function() {
- // uncomment below and update the code to test the property interactive
- //var instance = new PortainerApi.Template();
- //expect(instance).to.be();
- });
- it('should have the property restartPolicy (base name: "restart_policy")', function() {
- // uncomment below and update the code to test the property restartPolicy
- //var instance = new PortainerApi.Template();
- //expect(instance).to.be();
- });
- it('should have the property hostname (base name: "hostname")', function() {
- // uncomment below and update the code to test the property hostname
- //var instance = new PortainerApi.Template();
- //expect(instance).to.be();
- });
- });
- }));
|