naftiko: 1.0.0-alpha2 info: label: PortainerCE API 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 https://documentation.portainer.io/api/api-examples/ 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 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 provi' tags: - Portainer - API created: '2026-05-06' modified: '2026-05-06' capability: consumes: - type: http namespace: portainer baseUri: https://api.example.com description: PortainerCE API HTTP API. resources: - name: auth path: /auth operations: - name: authenticateuser method: POST description: Authenticate outputRawFormat: json outputParameters: - name: result type: object value: $. - name: auth-logout path: /auth/logout operations: - name: logout method: POST description: Logout outputRawFormat: json outputParameters: - name: result type: object value: $. - name: auth-oauth-validate path: /auth/oauth/validate operations: - name: validateoauth method: POST description: Authenticate with OAuth outputRawFormat: json outputParameters: - name: result type: object value: $. - name: backup path: /backup operations: - name: backup method: POST description: Creates an archive with a system data snapshot that could be used to restore the system. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: custom-templates path: /custom_templates operations: - name: customtemplatelist method: GET description: List available custom templates inputParameters: - name: type in: query type: string required: true description: Template types - name: edge in: query type: string description: Filter by edge templates outputRawFormat: json outputParameters: - name: result type: object value: $. - name: custom-templates-id path: /custom_templates/{id} operations: - name: customtemplatedelete method: DELETE description: Remove a template inputParameters: - name: id in: path type: string required: true description: Template identifier outputRawFormat: json outputParameters: - name: result type: object value: $. - name: customtemplateinspect method: GET description: Inspect a custom template inputParameters: - name: id in: path type: string required: true description: Template identifier outputRawFormat: json outputParameters: - name: result type: object value: $. - name: customtemplateupdate method: PUT description: Update a template inputParameters: - name: id in: path type: string required: true description: Template identifier outputRawFormat: json outputParameters: - name: result type: object value: $. - name: custom-templates-id-file path: /custom_templates/{id}/file operations: - name: customtemplatefile method: GET description: Get Template stack file content. inputParameters: - name: id in: path type: string required: true description: Template identifier outputRawFormat: json outputParameters: - name: result type: object value: $. - name: custom-templates-id-git-fetch path: /custom_templates/{id}/git_fetch operations: - name: customtemplategitfetch method: PUT description: Fetch the latest config file content based on custom template's git repository configuration inputParameters: - name: id in: path type: string required: true description: Template identifier outputRawFormat: json outputParameters: - name: result type: object value: $. - name: custom-templates-create-file path: /custom_templates/create/file operations: - name: customtemplatecreatefile method: POST description: Create a custom template outputRawFormat: json outputParameters: - name: result type: object value: $. - name: custom-templates-create-repository path: /custom_templates/create/repository operations: - name: customtemplatecreaterepository method: POST description: Create a custom template outputRawFormat: json outputParameters: - name: result type: object value: $. - name: custom-templates-create-string path: /custom_templates/create/string operations: - name: customtemplatecreatestring method: POST description: Create a custom template outputRawFormat: json outputParameters: - name: result type: object value: $. - name: docker-environmentid-containers-containerid-gpus path: /docker/{environmentId}/containers/{containerId}/gpus operations: - name: dockercontainergpusinspect method: GET description: Fetch container gpus data inputParameters: - name: environmentId in: path type: string required: true description: Environment identifier - name: containerId in: path type: string required: true description: Container identifier outputRawFormat: json outputParameters: - name: result type: object value: $. - name: docker-environmentid-dashboard path: /docker/{environmentId}/dashboard operations: - name: dockerdashboard method: GET description: Get counters for the dashboard inputParameters: - name: environmentId in: path type: string required: true description: Environment identifier outputRawFormat: json outputParameters: - name: result type: object value: $. - name: docker-environmentid-images path: /docker/{environmentId}/images operations: - name: dockerimageslist method: GET description: Fetch images inputParameters: - name: environmentId in: path type: string required: true description: Environment identifier - name: withUsage in: query type: string description: Include image usage information outputRawFormat: json outputParameters: - name: result type: object value: $. - name: edge-groups path: /edge_groups operations: - name: edgegrouplist method: GET description: list EdgeGroups outputRawFormat: json outputParameters: - name: result type: object value: $. - name: edgegroupcreate method: POST description: Create an EdgeGroup outputRawFormat: json outputParameters: - name: result type: object value: $. - name: edge-groups-id path: /edge_groups/{id} operations: - name: edgegroupdelete method: DELETE description: Deletes an EdgeGroup inputParameters: - name: id in: path type: string required: true description: EdgeGroup Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: edgegroupinspect method: GET description: Inspects an EdgeGroup inputParameters: - name: id in: path type: string required: true description: EdgeGroup Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: edgegroupupdate method: PUT description: Updates an EdgeGroup inputParameters: - name: id in: path type: string required: true description: EdgeGroup Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: edge-jobs path: /edge_jobs operations: - name: edgejoblist method: GET description: Fetch EdgeJobs list outputRawFormat: json outputParameters: - name: result type: object value: $. - name: edge-jobs-id path: /edge_jobs/{id} operations: - name: edgejobdelete method: DELETE description: Delete an EdgeJob inputParameters: - name: id in: path type: string required: true description: EdgeJob Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: edgejobinspect method: GET description: Inspect an EdgeJob inputParameters: - name: id in: path type: string required: true description: EdgeJob Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: edgejobupdate method: PUT description: Update an EdgeJob inputParameters: - name: id in: path type: string required: true description: EdgeJob Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: edge-jobs-id-file path: /edge_jobs/{id}/file operations: - name: edgejobfile method: GET description: Fetch a file of an EdgeJob inputParameters: - name: id in: path type: string required: true description: EdgeJob Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: edge-jobs-id-tasks path: /edge_jobs/{id}/tasks operations: - name: edgejobtaskslist method: GET description: Fetch the list of tasks on an EdgeJob inputParameters: - name: id in: path type: string required: true description: EdgeJob Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: edge-jobs-id-tasks-taskid-logs path: /edge_jobs/{id}/tasks/{taskID}/logs operations: - name: edgejobtasksclear method: DELETE description: Clear the log for a specifc task on an EdgeJob inputParameters: - name: id in: path type: string required: true description: EdgeJob Id - name: taskID in: path type: string required: true description: Task Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: edgejobtasklogsinspect method: GET description: Fetch the log for a specifc task on an EdgeJob inputParameters: - name: id in: path type: string required: true description: EdgeJob Id - name: taskID in: path type: string required: true description: Task Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: edgejobtaskscollect method: POST description: Collect the log for a specifc task on an EdgeJob inputParameters: - name: id in: path type: string required: true description: EdgeJob Id - name: taskID in: path type: string required: true description: Task Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: edge-jobs-create-file path: /edge_jobs/create/file operations: - name: edgejobcreatefile method: POST description: Create an EdgeJob from a file outputRawFormat: json outputParameters: - name: result type: object value: $. - name: edge-jobs-create-string path: /edge_jobs/create/string operations: - name: edgejobcreatestring method: POST description: Create an EdgeJob from a text outputRawFormat: json outputParameters: - name: result type: object value: $. - name: edge-stacks path: /edge_stacks operations: - name: edgestacklist method: GET description: Fetches the list of EdgeStacks inputParameters: - name: summarizeStatuses in: query type: string description: will summarize the statuses outputRawFormat: json outputParameters: - name: result type: object value: $. - name: edge-stacks-id path: /edge_stacks/{id} operations: - name: edgestackdelete method: DELETE description: Delete an EdgeStack inputParameters: - name: id in: path type: string required: true description: EdgeStack Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: edgestackinspect method: GET description: Inspect an EdgeStack inputParameters: - name: id in: path type: string required: true description: EdgeStack Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: edgestackupdate method: PUT description: Update an EdgeStack inputParameters: - name: id in: path type: string required: true description: EdgeStack Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: edge-stacks-id-file path: /edge_stacks/{id}/file operations: - name: edgestackfile method: GET description: Fetches the stack file for an EdgeStack inputParameters: - name: id in: path type: string required: true description: EdgeStack Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: edge-stacks-id-status path: /edge_stacks/{id}/status operations: - name: edgestackstatusupdate method: PUT description: Update an EdgeStack status inputParameters: - name: id in: path type: string required: true description: EdgeStack Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: edge-stacks-create-file path: /edge_stacks/create/file operations: - name: edgestackcreatefile method: POST description: Create an EdgeStack from file inputParameters: - name: dryrun in: query type: string description: if true, will not create an edge stack, but just will check the settings and return a non-persisted edge stack object outputRawFormat: json outputParameters: - name: result type: object value: $. - name: edge-stacks-create-repository path: /edge_stacks/create/repository operations: - name: edgestackcreaterepository method: POST description: Create an EdgeStack from a git repository inputParameters: - name: dryrun in: query type: string description: if true, will not create an edge stack, but just will check the settings and return a non-persisted edge stack object outputRawFormat: json outputParameters: - name: result type: object value: $. - name: edge-stacks-create-string path: /edge_stacks/create/string operations: - name: edgestackcreatestring method: POST description: Create an EdgeStack from a text inputParameters: - name: dryrun in: query type: string description: if true, will not create an edge stack, but just will check the settings and return a non-persisted edge stack object outputRawFormat: json outputParameters: - name: result type: object value: $. - name: endpoint-groups path: /endpoint_groups operations: - name: endpointgrouplist method: GET description: List Environment(Endpoint) groups outputRawFormat: json outputParameters: - name: result type: object value: $. - name: post-endpoint-groups method: POST description: Create an Environment(Endpoint) Group outputRawFormat: json outputParameters: - name: result type: object value: $. - name: endpoint-groups-id path: /endpoint_groups/{id} operations: - name: endpointgroupdelete method: DELETE description: Remove an environment(endpoint) group inputParameters: - name: id in: path type: string required: true description: EndpointGroup identifier outputRawFormat: json outputParameters: - name: result type: object value: $. - name: get-endpoint-groups-id method: GET description: Inspect an Environment(Endpoint) group inputParameters: - name: id in: path type: string required: true description: Environment(Endpoint) group identifier outputRawFormat: json outputParameters: - name: result type: object value: $. - name: endpointgroupupdate method: PUT description: Update an environment(endpoint) group inputParameters: - name: id in: path type: string required: true description: EndpointGroup identifier outputRawFormat: json outputParameters: - name: result type: object value: $. - name: endpoint-groups-id-endpoints-endpointid path: /endpoint_groups/{id}/endpoints/{endpointId} operations: - name: endpointgroupdeleteendpoint method: DELETE description: Removes environment(endpoint) from an environment(endpoint) group inputParameters: - name: id in: path type: string required: true description: EndpointGroup identifier - name: endpointId in: path type: string required: true description: Environment(Endpoint) identifier outputRawFormat: json outputParameters: - name: result type: object value: $. - name: endpointgroupaddendpoint method: PUT description: Add an environment(endpoint) to an environment(endpoint) group inputParameters: - name: id in: path type: string required: true description: EndpointGroup identifier - name: endpointId in: path type: string required: true description: Environment(Endpoint) identifier outputRawFormat: json outputParameters: - name: result type: object value: $. - name: endpoints path: /endpoints operations: - name: endpointdeletebatchdeprecated method: DELETE description: Remove multiple environments outputRawFormat: json outputParameters: - name: result type: object value: $. - name: endpointlist method: GET description: List environments(endpoints) inputParameters: - name: start in: query type: string description: Start searching from - name: limit in: query type: string description: Limit results to this value - name: sort in: query type: string description: Sort results by this value - name: order in: query type: string description: Order sorted results by desc/asc - name: search in: query type: string description: Search query - name: groupIds in: query type: string description: List environments(endpoints) of these groups - name: status in: query type: string description: List environments(endpoints) by this status - name: types in: query type: string description: List environments(endpoints) of this type - name: tagIds in: query type: string description: search environments(endpoints) with these tags (depends on tagsPartialMatch) - name: tagsPartialMatch in: query type: string description: If true, will return environment(endpoint) which has one of tagIds, if false (or missing) will return only environments(endpoints) that has all the tags - name: endpointIds in: query type: string description: will return only these environments(endpoints) - name: excludeIds in: query type: string description: will exclude these environments(endpoints) - name: excludeGroupIds in: query type: string description: will exclude environments(endpoints) belonging to these endpoint groups - name: provisioned in: query type: string description: If true, will return environment(endpoint) that were provisioned - name: agentVersions in: query type: string description: will return only environments with on of these agent versions - name: edgeAsync in: query type: string description: if exists true show only edge async agents, false show only standard edge agents. if missing, will show both types (relevant only for edge agents) - name: edgeDeviceUntrusted in: query type: string description: if true, show only untrusted edge agents, if false show only trusted edge agents (relevant only for edge agents) - name: edgeCheckInPassedSeconds in: query type: string description: if bigger then zero, show only edge agents that checked-in in the last provided seconds (relevant only for edge agents) - name: excludeSnapshots in: query type: string description: if true, the snapshot data won't be retrieved - name: name in: query type: string description: will return only environments(endpoints) with this name - name: edgeStackStatus in: query type: string description: only applied when edgeStackId exists. Filter the returned environments based on their deployment status in the stack (not the environment status!) - name: edgeGroupIds in: query type: string description: List environments(endpoints) of these edge groups - name: excludeEdgeGroupIds in: query type: string description: Exclude environments(endpoints) of these edge groups outputRawFormat: json outputParameters: - name: result type: object value: $. - name: endpointcreate method: POST description: Create a new environment(endpoint) outputRawFormat: json outputParameters: - name: result type: object value: $. - name: endpoints-id path: /endpoints/{id} operations: - name: endpointdelete method: DELETE description: Remove an environment inputParameters: - name: id in: path type: string required: true description: Environment(Endpoint) identifier outputRawFormat: json outputParameters: - name: result type: object value: $. - name: endpointinspect method: GET description: Inspect an environment(endpoint) inputParameters: - name: id in: path type: string required: true description: Environment(Endpoint) identifier - name: excludeSnapshot in: query type: string description: if true, the snapshot data won't be retrieved outputRawFormat: json outputParameters: - name: result type: object value: $. - name: endpointupdate method: PUT description: Update an environment(endpoint) inputParameters: - name: id in: path type: string required: true description: Environment(Endpoint) identifier outputRawFormat: json outputParameters: - name: result type: object value: $. - name: endpoints-id-association path: /endpoints/{id}/association operations: - name: endpointassociationdelete method: PUT description: De-association an edge environment(endpoint) inputParameters: - name: id in: path type: string required: true description: Environment(Endpoint) identifier outputRawFormat: json outputParameters: - name: result type: object value: $. - name: endpoints-id-docker-v2-browse-put path: /endpoints/{id}/docker/v2/browse/put operations: - name: post-endpoints-id-docker-v2-browse-put method: POST description: Upload a file under a specific path on the file system of an environment (endpoint) inputParameters: - name: id in: path type: string required: true description: Environment(Endpoint) identifier - name: volumeID in: query type: string description: Optional volume identifier to upload the file outputRawFormat: json outputParameters: - name: result type: object value: $. - name: endpoints-id-dockerhub-registryid path: /endpoints/{id}/dockerhub/{registryId} operations: - name: endpointdockerhubstatus method: GET description: fetch docker pull limits inputParameters: - name: id in: path type: string required: true description: endpoint ID - name: registryId in: path type: string required: true description: registry ID outputRawFormat: json outputParameters: - name: result type: object value: $. - name: endpoints-id-edge-jobs-jobid-logs path: /endpoints/{id}/edge/jobs/{jobID}/logs operations: - name: post-endpoints-id-edge-jobs-jobid-logs method: POST description: Update the logs collected from an Edge Job inputParameters: - name: id in: path type: string required: true description: environment(endpoint) Id - name: jobID in: path type: string required: true description: Job Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: endpoints-id-edge-stacks-stackid path: /endpoints/{id}/edge/stacks/{stackId} operations: - name: get-endpoints-id-edge-stacks-stackid method: GET description: Inspect an Edge Stack for an Environment(Endpoint) inputParameters: - name: id in: path type: string required: true description: environment(endpoint) Id - name: stackId in: path type: string required: true description: EdgeStack Id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: endpoints-id-edge-status path: /endpoints/{id}/edge/status operations: - name: endpointedgestatusinspect method: GET description: Get environment(endpoint) status inputParameters: - name: id in: path type: string required: true description: Environment(Endpoint) identifier outputRawFormat: json outputParameters: - name: result type: object value: $. exposes: - type: rest port: 8080 namespace: portainer-rest description: REST adapter for PortainerCE API. resources: - path: /auth name: authenticateuser operations: - method: POST name: authenticateuser description: Authenticate call: portainer.authenticateuser outputParameters: - type: object mapping: $. - path: /auth/logout name: logout operations: - method: POST name: logout description: Logout call: portainer.logout outputParameters: - type: object mapping: $. - path: /auth/oauth/validate name: validateoauth operations: - method: POST name: validateoauth description: Authenticate with OAuth call: portainer.validateoauth outputParameters: - type: object mapping: $. - path: /backup name: backup operations: - method: POST name: backup description: Creates an archive with a system data snapshot that could be used to restore the system. call: portainer.backup outputParameters: - type: object mapping: $. - path: /custom_templates name: customtemplatelist operations: - method: GET name: customtemplatelist description: List available custom templates call: portainer.customtemplatelist outputParameters: - type: object mapping: $. - path: /custom_templates/{id} name: customtemplatedelete operations: - method: DELETE name: customtemplatedelete description: Remove a template call: portainer.customtemplatedelete with: id: rest.id outputParameters: - type: object mapping: $. - path: /custom_templates/{id} name: customtemplateinspect operations: - method: GET name: customtemplateinspect description: Inspect a custom template call: portainer.customtemplateinspect with: id: rest.id outputParameters: - type: object mapping: $. - path: /custom_templates/{id} name: customtemplateupdate operations: - method: PUT name: customtemplateupdate description: Update a template call: portainer.customtemplateupdate with: id: rest.id outputParameters: - type: object mapping: $. - path: /custom_templates/{id}/file name: customtemplatefile operations: - method: GET name: customtemplatefile description: Get Template stack file content. call: portainer.customtemplatefile with: id: rest.id outputParameters: - type: object mapping: $. - path: /custom_templates/{id}/git_fetch name: customtemplategitfetch operations: - method: PUT name: customtemplategitfetch description: Fetch the latest config file content based on custom template's git repository configuration call: portainer.customtemplategitfetch with: id: rest.id outputParameters: - type: object mapping: $. - path: /custom_templates/create/file name: customtemplatecreatefile operations: - method: POST name: customtemplatecreatefile description: Create a custom template call: portainer.customtemplatecreatefile outputParameters: - type: object mapping: $. - path: /custom_templates/create/repository name: customtemplatecreaterepository operations: - method: POST name: customtemplatecreaterepository description: Create a custom template call: portainer.customtemplatecreaterepository outputParameters: - type: object mapping: $. - path: /custom_templates/create/string name: customtemplatecreatestring operations: - method: POST name: customtemplatecreatestring description: Create a custom template call: portainer.customtemplatecreatestring outputParameters: - type: object mapping: $. - path: /docker/{environmentId}/containers/{containerId}/gpus name: dockercontainergpusinspect operations: - method: GET name: dockercontainergpusinspect description: Fetch container gpus data call: portainer.dockercontainergpusinspect with: environmentId: rest.environmentId containerId: rest.containerId outputParameters: - type: object mapping: $. - path: /docker/{environmentId}/dashboard name: dockerdashboard operations: - method: GET name: dockerdashboard description: Get counters for the dashboard call: portainer.dockerdashboard with: environmentId: rest.environmentId outputParameters: - type: object mapping: $. - path: /docker/{environmentId}/images name: dockerimageslist operations: - method: GET name: dockerimageslist description: Fetch images call: portainer.dockerimageslist with: environmentId: rest.environmentId outputParameters: - type: object mapping: $. - path: /edge_groups name: edgegrouplist operations: - method: GET name: edgegrouplist description: list EdgeGroups call: portainer.edgegrouplist outputParameters: - type: object mapping: $. - path: /edge_groups name: edgegroupcreate operations: - method: POST name: edgegroupcreate description: Create an EdgeGroup call: portainer.edgegroupcreate outputParameters: - type: object mapping: $. - path: /edge_groups/{id} name: edgegroupdelete operations: - method: DELETE name: edgegroupdelete description: Deletes an EdgeGroup call: portainer.edgegroupdelete with: id: rest.id outputParameters: - type: object mapping: $. - path: /edge_groups/{id} name: edgegroupinspect operations: - method: GET name: edgegroupinspect description: Inspects an EdgeGroup call: portainer.edgegroupinspect with: id: rest.id outputParameters: - type: object mapping: $. - path: /edge_groups/{id} name: edgegroupupdate operations: - method: PUT name: edgegroupupdate description: Updates an EdgeGroup call: portainer.edgegroupupdate with: id: rest.id outputParameters: - type: object mapping: $. - path: /edge_jobs name: edgejoblist operations: - method: GET name: edgejoblist description: Fetch EdgeJobs list call: portainer.edgejoblist outputParameters: - type: object mapping: $. - path: /edge_jobs/{id} name: edgejobdelete operations: - method: DELETE name: edgejobdelete description: Delete an EdgeJob call: portainer.edgejobdelete with: id: rest.id outputParameters: - type: object mapping: $. - path: /edge_jobs/{id} name: edgejobinspect operations: - method: GET name: edgejobinspect description: Inspect an EdgeJob call: portainer.edgejobinspect with: id: rest.id outputParameters: - type: object mapping: $. - path: /edge_jobs/{id} name: edgejobupdate operations: - method: PUT name: edgejobupdate description: Update an EdgeJob call: portainer.edgejobupdate with: id: rest.id outputParameters: - type: object mapping: $. - path: /edge_jobs/{id}/file name: edgejobfile operations: - method: GET name: edgejobfile description: Fetch a file of an EdgeJob call: portainer.edgejobfile with: id: rest.id outputParameters: - type: object mapping: $. - path: /edge_jobs/{id}/tasks name: edgejobtaskslist operations: - method: GET name: edgejobtaskslist description: Fetch the list of tasks on an EdgeJob call: portainer.edgejobtaskslist with: id: rest.id outputParameters: - type: object mapping: $. - path: /edge_jobs/{id}/tasks/{taskID}/logs name: edgejobtasksclear operations: - method: DELETE name: edgejobtasksclear description: Clear the log for a specifc task on an EdgeJob call: portainer.edgejobtasksclear with: id: rest.id taskID: rest.taskID outputParameters: - type: object mapping: $. - path: /edge_jobs/{id}/tasks/{taskID}/logs name: edgejobtasklogsinspect operations: - method: GET name: edgejobtasklogsinspect description: Fetch the log for a specifc task on an EdgeJob call: portainer.edgejobtasklogsinspect with: id: rest.id taskID: rest.taskID outputParameters: - type: object mapping: $. - path: /edge_jobs/{id}/tasks/{taskID}/logs name: edgejobtaskscollect operations: - method: POST name: edgejobtaskscollect description: Collect the log for a specifc task on an EdgeJob call: portainer.edgejobtaskscollect with: id: rest.id taskID: rest.taskID outputParameters: - type: object mapping: $. - path: /edge_jobs/create/file name: edgejobcreatefile operations: - method: POST name: edgejobcreatefile description: Create an EdgeJob from a file call: portainer.edgejobcreatefile outputParameters: - type: object mapping: $. - path: /edge_jobs/create/string name: edgejobcreatestring operations: - method: POST name: edgejobcreatestring description: Create an EdgeJob from a text call: portainer.edgejobcreatestring outputParameters: - type: object mapping: $. - path: /edge_stacks name: edgestacklist operations: - method: GET name: edgestacklist description: Fetches the list of EdgeStacks call: portainer.edgestacklist outputParameters: - type: object mapping: $. - path: /edge_stacks/{id} name: edgestackdelete operations: - method: DELETE name: edgestackdelete description: Delete an EdgeStack call: portainer.edgestackdelete with: id: rest.id outputParameters: - type: object mapping: $. - path: /edge_stacks/{id} name: edgestackinspect operations: - method: GET name: edgestackinspect description: Inspect an EdgeStack call: portainer.edgestackinspect with: id: rest.id outputParameters: - type: object mapping: $. - path: /edge_stacks/{id} name: edgestackupdate operations: - method: PUT name: edgestackupdate description: Update an EdgeStack call: portainer.edgestackupdate with: id: rest.id outputParameters: - type: object mapping: $. - path: /edge_stacks/{id}/file name: edgestackfile operations: - method: GET name: edgestackfile description: Fetches the stack file for an EdgeStack call: portainer.edgestackfile with: id: rest.id outputParameters: - type: object mapping: $. - path: /edge_stacks/{id}/status name: edgestackstatusupdate operations: - method: PUT name: edgestackstatusupdate description: Update an EdgeStack status call: portainer.edgestackstatusupdate with: id: rest.id outputParameters: - type: object mapping: $. - path: /edge_stacks/create/file name: edgestackcreatefile operations: - method: POST name: edgestackcreatefile description: Create an EdgeStack from file call: portainer.edgestackcreatefile outputParameters: - type: object mapping: $. - path: /edge_stacks/create/repository name: edgestackcreaterepository operations: - method: POST name: edgestackcreaterepository description: Create an EdgeStack from a git repository call: portainer.edgestackcreaterepository outputParameters: - type: object mapping: $. - path: /edge_stacks/create/string name: edgestackcreatestring operations: - method: POST name: edgestackcreatestring description: Create an EdgeStack from a text call: portainer.edgestackcreatestring outputParameters: - type: object mapping: $. - path: /endpoint_groups name: endpointgrouplist operations: - method: GET name: endpointgrouplist description: List Environment(Endpoint) groups call: portainer.endpointgrouplist outputParameters: - type: object mapping: $. - path: /endpoint_groups name: post-endpoint-groups operations: - method: POST name: post-endpoint-groups description: Create an Environment(Endpoint) Group call: portainer.post-endpoint-groups outputParameters: - type: object mapping: $. - path: /endpoint_groups/{id} name: endpointgroupdelete operations: - method: DELETE name: endpointgroupdelete description: Remove an environment(endpoint) group call: portainer.endpointgroupdelete with: id: rest.id outputParameters: - type: object mapping: $. - path: /endpoint_groups/{id} name: get-endpoint-groups-id operations: - method: GET name: get-endpoint-groups-id description: Inspect an Environment(Endpoint) group call: portainer.get-endpoint-groups-id with: id: rest.id outputParameters: - type: object mapping: $. - path: /endpoint_groups/{id} name: endpointgroupupdate operations: - method: PUT name: endpointgroupupdate description: Update an environment(endpoint) group call: portainer.endpointgroupupdate with: id: rest.id outputParameters: - type: object mapping: $. - path: /endpoint_groups/{id}/endpoints/{endpointId} name: endpointgroupdeleteendpoint operations: - method: DELETE name: endpointgroupdeleteendpoint description: Removes environment(endpoint) from an environment(endpoint) group call: portainer.endpointgroupdeleteendpoint with: id: rest.id endpointId: rest.endpointId outputParameters: - type: object mapping: $. - path: /endpoint_groups/{id}/endpoints/{endpointId} name: endpointgroupaddendpoint operations: - method: PUT name: endpointgroupaddendpoint description: Add an environment(endpoint) to an environment(endpoint) group call: portainer.endpointgroupaddendpoint with: id: rest.id endpointId: rest.endpointId outputParameters: - type: object mapping: $. - path: /endpoints name: endpointdeletebatchdeprecated operations: - method: DELETE name: endpointdeletebatchdeprecated description: Remove multiple environments call: portainer.endpointdeletebatchdeprecated outputParameters: - type: object mapping: $. - path: /endpoints name: endpointlist operations: - method: GET name: endpointlist description: List environments(endpoints) call: portainer.endpointlist outputParameters: - type: object mapping: $. - path: /endpoints name: endpointcreate operations: - method: POST name: endpointcreate description: Create a new environment(endpoint) call: portainer.endpointcreate outputParameters: - type: object mapping: $. - path: /endpoints/{id} name: endpointdelete operations: - method: DELETE name: endpointdelete description: Remove an environment call: portainer.endpointdelete with: id: rest.id outputParameters: - type: object mapping: $. - path: /endpoints/{id} name: endpointinspect operations: - method: GET name: endpointinspect description: Inspect an environment(endpoint) call: portainer.endpointinspect with: id: rest.id outputParameters: - type: object mapping: $. - path: /endpoints/{id} name: endpointupdate operations: - method: PUT name: endpointupdate description: Update an environment(endpoint) call: portainer.endpointupdate with: id: rest.id outputParameters: - type: object mapping: $. - path: /endpoints/{id}/association name: endpointassociationdelete operations: - method: PUT name: endpointassociationdelete description: De-association an edge environment(endpoint) call: portainer.endpointassociationdelete with: id: rest.id outputParameters: - type: object mapping: $. - path: /endpoints/{id}/docker/v2/browse/put name: post-endpoints-id-docker-v2-browse-put operations: - method: POST name: post-endpoints-id-docker-v2-browse-put description: Upload a file under a specific path on the file system of an environment (endpoint) call: portainer.post-endpoints-id-docker-v2-browse-put with: id: rest.id outputParameters: - type: object mapping: $. - path: /endpoints/{id}/dockerhub/{registryId} name: endpointdockerhubstatus operations: - method: GET name: endpointdockerhubstatus description: fetch docker pull limits call: portainer.endpointdockerhubstatus with: id: rest.id registryId: rest.registryId outputParameters: - type: object mapping: $. - path: /endpoints/{id}/edge/jobs/{jobID}/logs name: post-endpoints-id-edge-jobs-jobid-logs operations: - method: POST name: post-endpoints-id-edge-jobs-jobid-logs description: Update the logs collected from an Edge Job call: portainer.post-endpoints-id-edge-jobs-jobid-logs with: id: rest.id jobID: rest.jobID outputParameters: - type: object mapping: $. - path: /endpoints/{id}/edge/stacks/{stackId} name: get-endpoints-id-edge-stacks-stackid operations: - method: GET name: get-endpoints-id-edge-stacks-stackid description: Inspect an Edge Stack for an Environment(Endpoint) call: portainer.get-endpoints-id-edge-stacks-stackid with: id: rest.id stackId: rest.stackId outputParameters: - type: object mapping: $. - path: /endpoints/{id}/edge/status name: endpointedgestatusinspect operations: - method: GET name: endpointedgestatusinspect description: Get environment(endpoint) status call: portainer.endpointedgestatusinspect with: id: rest.id outputParameters: - type: object mapping: $. - type: mcp port: 9090 namespace: portainer-mcp transport: http description: MCP adapter for PortainerCE API for AI agent use. tools: - name: authenticateuser description: Authenticate hints: readOnly: false destructive: false idempotent: false call: portainer.authenticateuser outputParameters: - type: object mapping: $. - name: logout description: Logout hints: readOnly: false destructive: false idempotent: false call: portainer.logout outputParameters: - type: object mapping: $. - name: validateoauth description: Authenticate with OAuth hints: readOnly: false destructive: false idempotent: false call: portainer.validateoauth outputParameters: - type: object mapping: $. - name: backup description: Creates an archive with a system data snapshot that could be used to restore the system. hints: readOnly: false destructive: false idempotent: false call: portainer.backup outputParameters: - type: object mapping: $. - name: customtemplatelist description: List available custom templates hints: readOnly: true destructive: false idempotent: true call: portainer.customtemplatelist with: type: tools.type edge: tools.edge inputParameters: - name: type type: string description: Template types required: true - name: edge type: string description: Filter by edge templates outputParameters: - type: object mapping: $. - name: customtemplatedelete description: Remove a template hints: readOnly: false destructive: true idempotent: true call: portainer.customtemplatedelete with: id: tools.id inputParameters: - name: id type: string description: Template identifier required: true outputParameters: - type: object mapping: $. - name: customtemplateinspect description: Inspect a custom template hints: readOnly: true destructive: false idempotent: true call: portainer.customtemplateinspect with: id: tools.id inputParameters: - name: id type: string description: Template identifier required: true outputParameters: - type: object mapping: $. - name: customtemplateupdate description: Update a template hints: readOnly: false destructive: false idempotent: true call: portainer.customtemplateupdate with: id: tools.id inputParameters: - name: id type: string description: Template identifier required: true outputParameters: - type: object mapping: $. - name: customtemplatefile description: Get Template stack file content. hints: readOnly: true destructive: false idempotent: true call: portainer.customtemplatefile with: id: tools.id inputParameters: - name: id type: string description: Template identifier required: true outputParameters: - type: object mapping: $. - name: customtemplategitfetch description: Fetch the latest config file content based on custom template's git repository configuration hints: readOnly: false destructive: false idempotent: true call: portainer.customtemplategitfetch with: id: tools.id inputParameters: - name: id type: string description: Template identifier required: true outputParameters: - type: object mapping: $. - name: customtemplatecreatefile description: Create a custom template hints: readOnly: false destructive: false idempotent: false call: portainer.customtemplatecreatefile outputParameters: - type: object mapping: $. - name: customtemplatecreaterepository description: Create a custom template hints: readOnly: false destructive: false idempotent: false call: portainer.customtemplatecreaterepository outputParameters: - type: object mapping: $. - name: customtemplatecreatestring description: Create a custom template hints: readOnly: false destructive: false idempotent: false call: portainer.customtemplatecreatestring outputParameters: - type: object mapping: $. - name: dockercontainergpusinspect description: Fetch container gpus data hints: readOnly: true destructive: false idempotent: true call: portainer.dockercontainergpusinspect with: environmentId: tools.environmentId containerId: tools.containerId inputParameters: - name: environmentId type: string description: Environment identifier required: true - name: containerId type: string description: Container identifier required: true outputParameters: - type: object mapping: $. - name: dockerdashboard description: Get counters for the dashboard hints: readOnly: true destructive: false idempotent: true call: portainer.dockerdashboard with: environmentId: tools.environmentId inputParameters: - name: environmentId type: string description: Environment identifier required: true outputParameters: - type: object mapping: $. - name: dockerimageslist description: Fetch images hints: readOnly: true destructive: false idempotent: true call: portainer.dockerimageslist with: environmentId: tools.environmentId withUsage: tools.withUsage inputParameters: - name: environmentId type: string description: Environment identifier required: true - name: withUsage type: string description: Include image usage information outputParameters: - type: object mapping: $. - name: edgegrouplist description: list EdgeGroups hints: readOnly: true destructive: false idempotent: true call: portainer.edgegrouplist outputParameters: - type: object mapping: $. - name: edgegroupcreate description: Create an EdgeGroup hints: readOnly: false destructive: false idempotent: false call: portainer.edgegroupcreate outputParameters: - type: object mapping: $. - name: edgegroupdelete description: Deletes an EdgeGroup hints: readOnly: false destructive: true idempotent: true call: portainer.edgegroupdelete with: id: tools.id inputParameters: - name: id type: string description: EdgeGroup Id required: true outputParameters: - type: object mapping: $. - name: edgegroupinspect description: Inspects an EdgeGroup hints: readOnly: true destructive: false idempotent: true call: portainer.edgegroupinspect with: id: tools.id inputParameters: - name: id type: string description: EdgeGroup Id required: true outputParameters: - type: object mapping: $. - name: edgegroupupdate description: Updates an EdgeGroup hints: readOnly: false destructive: false idempotent: true call: portainer.edgegroupupdate with: id: tools.id inputParameters: - name: id type: string description: EdgeGroup Id required: true outputParameters: - type: object mapping: $. - name: edgejoblist description: Fetch EdgeJobs list hints: readOnly: true destructive: false idempotent: true call: portainer.edgejoblist outputParameters: - type: object mapping: $. - name: edgejobdelete description: Delete an EdgeJob hints: readOnly: false destructive: true idempotent: true call: portainer.edgejobdelete with: id: tools.id inputParameters: - name: id type: string description: EdgeJob Id required: true outputParameters: - type: object mapping: $. - name: edgejobinspect description: Inspect an EdgeJob hints: readOnly: true destructive: false idempotent: true call: portainer.edgejobinspect with: id: tools.id inputParameters: - name: id type: string description: EdgeJob Id required: true outputParameters: - type: object mapping: $. - name: edgejobupdate description: Update an EdgeJob hints: readOnly: false destructive: false idempotent: true call: portainer.edgejobupdate with: id: tools.id inputParameters: - name: id type: string description: EdgeJob Id required: true outputParameters: - type: object mapping: $. - name: edgejobfile description: Fetch a file of an EdgeJob hints: readOnly: true destructive: false idempotent: true call: portainer.edgejobfile with: id: tools.id inputParameters: - name: id type: string description: EdgeJob Id required: true outputParameters: - type: object mapping: $. - name: edgejobtaskslist description: Fetch the list of tasks on an EdgeJob hints: readOnly: true destructive: false idempotent: true call: portainer.edgejobtaskslist with: id: tools.id inputParameters: - name: id type: string description: EdgeJob Id required: true outputParameters: - type: object mapping: $. - name: edgejobtasksclear description: Clear the log for a specifc task on an EdgeJob hints: readOnly: false destructive: true idempotent: true call: portainer.edgejobtasksclear with: id: tools.id taskID: tools.taskID inputParameters: - name: id type: string description: EdgeJob Id required: true - name: taskID type: string description: Task Id required: true outputParameters: - type: object mapping: $. - name: edgejobtasklogsinspect description: Fetch the log for a specifc task on an EdgeJob hints: readOnly: true destructive: false idempotent: true call: portainer.edgejobtasklogsinspect with: id: tools.id taskID: tools.taskID inputParameters: - name: id type: string description: EdgeJob Id required: true - name: taskID type: string description: Task Id required: true outputParameters: - type: object mapping: $. - name: edgejobtaskscollect description: Collect the log for a specifc task on an EdgeJob hints: readOnly: false destructive: false idempotent: false call: portainer.edgejobtaskscollect with: id: tools.id taskID: tools.taskID inputParameters: - name: id type: string description: EdgeJob Id required: true - name: taskID type: string description: Task Id required: true outputParameters: - type: object mapping: $. - name: edgejobcreatefile description: Create an EdgeJob from a file hints: readOnly: false destructive: false idempotent: false call: portainer.edgejobcreatefile outputParameters: - type: object mapping: $. - name: edgejobcreatestring description: Create an EdgeJob from a text hints: readOnly: false destructive: false idempotent: false call: portainer.edgejobcreatestring outputParameters: - type: object mapping: $. - name: edgestacklist description: Fetches the list of EdgeStacks hints: readOnly: true destructive: false idempotent: true call: portainer.edgestacklist with: summarizeStatuses: tools.summarizeStatuses inputParameters: - name: summarizeStatuses type: string description: will summarize the statuses outputParameters: - type: object mapping: $. - name: edgestackdelete description: Delete an EdgeStack hints: readOnly: false destructive: true idempotent: true call: portainer.edgestackdelete with: id: tools.id inputParameters: - name: id type: string description: EdgeStack Id required: true outputParameters: - type: object mapping: $. - name: edgestackinspect description: Inspect an EdgeStack hints: readOnly: true destructive: false idempotent: true call: portainer.edgestackinspect with: id: tools.id inputParameters: - name: id type: string description: EdgeStack Id required: true outputParameters: - type: object mapping: $. - name: edgestackupdate description: Update an EdgeStack hints: readOnly: false destructive: false idempotent: true call: portainer.edgestackupdate with: id: tools.id inputParameters: - name: id type: string description: EdgeStack Id required: true outputParameters: - type: object mapping: $. - name: edgestackfile description: Fetches the stack file for an EdgeStack hints: readOnly: true destructive: false idempotent: true call: portainer.edgestackfile with: id: tools.id inputParameters: - name: id type: string description: EdgeStack Id required: true outputParameters: - type: object mapping: $. - name: edgestackstatusupdate description: Update an EdgeStack status hints: readOnly: false destructive: false idempotent: true call: portainer.edgestackstatusupdate with: id: tools.id inputParameters: - name: id type: string description: EdgeStack Id required: true outputParameters: - type: object mapping: $. - name: edgestackcreatefile description: Create an EdgeStack from file hints: readOnly: false destructive: false idempotent: false call: portainer.edgestackcreatefile with: dryrun: tools.dryrun inputParameters: - name: dryrun type: string description: if true, will not create an edge stack, but just will check the settings and return a non-persisted edge stack object outputParameters: - type: object mapping: $. - name: edgestackcreaterepository description: Create an EdgeStack from a git repository hints: readOnly: false destructive: false idempotent: false call: portainer.edgestackcreaterepository with: dryrun: tools.dryrun inputParameters: - name: dryrun type: string description: if true, will not create an edge stack, but just will check the settings and return a non-persisted edge stack object outputParameters: - type: object mapping: $. - name: edgestackcreatestring description: Create an EdgeStack from a text hints: readOnly: false destructive: false idempotent: false call: portainer.edgestackcreatestring with: dryrun: tools.dryrun inputParameters: - name: dryrun type: string description: if true, will not create an edge stack, but just will check the settings and return a non-persisted edge stack object outputParameters: - type: object mapping: $. - name: endpointgrouplist description: List Environment(Endpoint) groups hints: readOnly: true destructive: false idempotent: true call: portainer.endpointgrouplist outputParameters: - type: object mapping: $. - name: post-endpoint-groups description: Create an Environment(Endpoint) Group hints: readOnly: false destructive: false idempotent: false call: portainer.post-endpoint-groups outputParameters: - type: object mapping: $. - name: endpointgroupdelete description: Remove an environment(endpoint) group hints: readOnly: false destructive: true idempotent: true call: portainer.endpointgroupdelete with: id: tools.id inputParameters: - name: id type: string description: EndpointGroup identifier required: true outputParameters: - type: object mapping: $. - name: get-endpoint-groups-id description: Inspect an Environment(Endpoint) group hints: readOnly: true destructive: false idempotent: true call: portainer.get-endpoint-groups-id with: id: tools.id inputParameters: - name: id type: string description: Environment(Endpoint) group identifier required: true outputParameters: - type: object mapping: $. - name: endpointgroupupdate description: Update an environment(endpoint) group hints: readOnly: false destructive: false idempotent: true call: portainer.endpointgroupupdate with: id: tools.id inputParameters: - name: id type: string description: EndpointGroup identifier required: true outputParameters: - type: object mapping: $. - name: endpointgroupdeleteendpoint description: Removes environment(endpoint) from an environment(endpoint) group hints: readOnly: false destructive: true idempotent: true call: portainer.endpointgroupdeleteendpoint with: id: tools.id endpointId: tools.endpointId inputParameters: - name: id type: string description: EndpointGroup identifier required: true - name: endpointId type: string description: Environment(Endpoint) identifier required: true outputParameters: - type: object mapping: $. - name: endpointgroupaddendpoint description: Add an environment(endpoint) to an environment(endpoint) group hints: readOnly: false destructive: false idempotent: true call: portainer.endpointgroupaddendpoint with: id: tools.id endpointId: tools.endpointId inputParameters: - name: id type: string description: EndpointGroup identifier required: true - name: endpointId type: string description: Environment(Endpoint) identifier required: true outputParameters: - type: object mapping: $. - name: endpointdeletebatchdeprecated description: Remove multiple environments hints: readOnly: false destructive: true idempotent: true call: portainer.endpointdeletebatchdeprecated outputParameters: - type: object mapping: $. - name: endpointlist description: List environments(endpoints) hints: readOnly: true destructive: false idempotent: true call: portainer.endpointlist with: start: tools.start limit: tools.limit sort: tools.sort order: tools.order search: tools.search groupIds: tools.groupIds status: tools.status types: tools.types tagIds: tools.tagIds tagsPartialMatch: tools.tagsPartialMatch endpointIds: tools.endpointIds excludeIds: tools.excludeIds excludeGroupIds: tools.excludeGroupIds provisioned: tools.provisioned agentVersions: tools.agentVersions edgeAsync: tools.edgeAsync edgeDeviceUntrusted: tools.edgeDeviceUntrusted edgeCheckInPassedSeconds: tools.edgeCheckInPassedSeconds excludeSnapshots: tools.excludeSnapshots name: tools.name edgeStackStatus: tools.edgeStackStatus edgeGroupIds: tools.edgeGroupIds excludeEdgeGroupIds: tools.excludeEdgeGroupIds inputParameters: - name: start type: string description: Start searching from - name: limit type: string description: Limit results to this value - name: sort type: string description: Sort results by this value - name: order type: string description: Order sorted results by desc/asc - name: search type: string description: Search query - name: groupIds type: string description: List environments(endpoints) of these groups - name: status type: string description: List environments(endpoints) by this status - name: types type: string description: List environments(endpoints) of this type - name: tagIds type: string description: search environments(endpoints) with these tags (depends on tagsPartialMatch) - name: tagsPartialMatch type: string description: If true, will return environment(endpoint) which has one of tagIds, if false (or missing) will return only environments(endpoints) that has all the tags - name: endpointIds type: string description: will return only these environments(endpoints) - name: excludeIds type: string description: will exclude these environments(endpoints) - name: excludeGroupIds type: string description: will exclude environments(endpoints) belonging to these endpoint groups - name: provisioned type: string description: If true, will return environment(endpoint) that were provisioned - name: agentVersions type: string description: will return only environments with on of these agent versions - name: edgeAsync type: string description: if exists true show only edge async agents, false show only standard edge agents. if missing, will show both types (relevant only for edge agents) - name: edgeDeviceUntrusted type: string description: if true, show only untrusted edge agents, if false show only trusted edge agents (relevant only for edge agents) - name: edgeCheckInPassedSeconds type: string description: if bigger then zero, show only edge agents that checked-in in the last provided seconds (relevant only for edge agents) - name: excludeSnapshots type: string description: if true, the snapshot data won't be retrieved - name: name type: string description: will return only environments(endpoints) with this name - name: edgeStackStatus type: string description: only applied when edgeStackId exists. Filter the returned environments based on their deployment status in the stack (not the environment status!) - name: edgeGroupIds type: string description: List environments(endpoints) of these edge groups - name: excludeEdgeGroupIds type: string description: Exclude environments(endpoints) of these edge groups outputParameters: - type: object mapping: $. - name: endpointcreate description: Create a new environment(endpoint) hints: readOnly: false destructive: false idempotent: false call: portainer.endpointcreate outputParameters: - type: object mapping: $. - name: endpointdelete description: Remove an environment hints: readOnly: false destructive: true idempotent: true call: portainer.endpointdelete with: id: tools.id inputParameters: - name: id type: string description: Environment(Endpoint) identifier required: true outputParameters: - type: object mapping: $. - name: endpointinspect description: Inspect an environment(endpoint) hints: readOnly: true destructive: false idempotent: true call: portainer.endpointinspect with: id: tools.id excludeSnapshot: tools.excludeSnapshot inputParameters: - name: id type: string description: Environment(Endpoint) identifier required: true - name: excludeSnapshot type: string description: if true, the snapshot data won't be retrieved outputParameters: - type: object mapping: $. - name: endpointupdate description: Update an environment(endpoint) hints: readOnly: false destructive: false idempotent: true call: portainer.endpointupdate with: id: tools.id inputParameters: - name: id type: string description: Environment(Endpoint) identifier required: true outputParameters: - type: object mapping: $. - name: endpointassociationdelete description: De-association an edge environment(endpoint) hints: readOnly: false destructive: false idempotent: true call: portainer.endpointassociationdelete with: id: tools.id inputParameters: - name: id type: string description: Environment(Endpoint) identifier required: true outputParameters: - type: object mapping: $. - name: post-endpoints-id-docker-v2-browse-put description: Upload a file under a specific path on the file system of an environment (endpoint) hints: readOnly: false destructive: false idempotent: false call: portainer.post-endpoints-id-docker-v2-browse-put with: id: tools.id volumeID: tools.volumeID inputParameters: - name: id type: string description: Environment(Endpoint) identifier required: true - name: volumeID type: string description: Optional volume identifier to upload the file outputParameters: - type: object mapping: $. - name: endpointdockerhubstatus description: fetch docker pull limits hints: readOnly: true destructive: false idempotent: true call: portainer.endpointdockerhubstatus with: id: tools.id registryId: tools.registryId inputParameters: - name: id type: string description: endpoint ID required: true - name: registryId type: string description: registry ID required: true outputParameters: - type: object mapping: $. - name: post-endpoints-id-edge-jobs-jobid-logs description: Update the logs collected from an Edge Job hints: readOnly: false destructive: false idempotent: false call: portainer.post-endpoints-id-edge-jobs-jobid-logs with: id: tools.id jobID: tools.jobID inputParameters: - name: id type: string description: environment(endpoint) Id required: true - name: jobID type: string description: Job Id required: true outputParameters: - type: object mapping: $. - name: get-endpoints-id-edge-stacks-stackid description: Inspect an Edge Stack for an Environment(Endpoint) hints: readOnly: true destructive: false idempotent: true call: portainer.get-endpoints-id-edge-stacks-stackid with: id: tools.id stackId: tools.stackId inputParameters: - name: id type: string description: environment(endpoint) Id required: true - name: stackId type: string description: EdgeStack Id required: true outputParameters: - type: object mapping: $. - name: endpointedgestatusinspect description: Get environment(endpoint) status hints: readOnly: true destructive: false idempotent: true call: portainer.endpointedgestatusinspect with: id: tools.id inputParameters: - name: id type: string description: Environment(Endpoint) identifier required: true outputParameters: - type: object mapping: $.