Sign in

v13

latestOpenAPI 3.0.0zlibraw.githubusercontent.com2026-08-01265409652.5 KB
endpoints

Update settings for an environment(endpoint)

Update settings for an environment(endpoint). Access policy: authenticated

put/endpoints/{id}/settings

Path parameters

idinteger required

Environment(Endpoint) identifier

Request body

allowBindMountsForRegularUsersboolean

Whether non-administrator should be able to use bind mounts when creating containers

allowContainerCapabilitiesForRegularUsersboolean

Whether non-administrator should be able to use container capabilities

allowDeviceMappingForRegularUsersboolean

Whether non-administrator should be able to use device mapping

allowHostNamespaceForRegularUsersboolean

Whether non-administrator should be able to use the host pid

allowPrivilegedModeForRegularUsersboolean

Whether non-administrator should be able to use privileged mode when creating containers

allowSecurityOptForRegularUsersboolean

Whether non-administrator should be able to use security-opt settings

allowStackManagementForRegularUsersboolean

Whether non-administrator should be able to manage stacks

allowSysctlSettingForRegularUsersboolean

Whether non-administrator should be able to use sysctl settings

allowVolumeBrowserForRegularUsersboolean

Whether non-administrator should be able to browse volumes

enableGPUManagementboolean
enableHostManagementFeaturesboolean

Whether host management features are enabled

Example request

{
  "allowContainerCapabilitiesForRegularUsers": true,
  "allowDeviceMappingForRegularUsers": true,
  "allowHostNamespaceForRegularUsers": true,
  "allowSecurityOptForRegularUsers": true,
  "allowStackManagementForRegularUsers": true,
  "allowSysctlSettingForRegularUsers": true,
  "allowVolumeBrowserForRegularUsers": true,
  "enableHostManagementFeatures": true,
  "gpus": [
    {
      "name": "name",
      "value": "value"
    }
  ]
}

Response

Success

ComposeSyntaxMaxVersionstring required

Maximum version of docker-compose

ContainerEnginestring required

ContainerEngine represents the container engine type. This can be 'docker' or 'podman' when interacting directly with these environments, otherwise '' for kubernetes environments.

EdgeCheckinIntervalinteger required

The check in interval for edge agent (in seconds)

EdgeIDstring

The identifier of the edge agent associated with this environment(endpoint)

EdgeKeystring required

The key which is used to map the agent to Portainer

EnableGPUManagementboolean
GroupIdinteger required

Environment(Endpoint) group identifier

Heartbeatboolean

Heartbeat indicates the heartbeat status of an edge environment

Idinteger required

Environment(Endpoint) Identifier

LastCheckInDateinteger required

LastCheckInDate mark last check-in date on checkin

Namestring required

Environment(Endpoint) name

PublicURLstring required

URL or IP address where exposed containers will be reachable

Status0 | 1 | 2
TagIdsinteger[]

List of tag identifiers to which this environment(endpoint) is associated

TeamAccessPoliciesPortainerTeamAccessPolicies
Type0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 required
URLstring required

URL or IP address of the Docker host associated to this environment(endpoint)

UserAccessPoliciesPortainerUserAccessPolicies
UserTrustedboolean

Whether the device has been trusted or not by the user

Example response

{
  "Agent": {
    "Version": "1.0.0"
  },
  "AzureCredentials": {
    "ApplicationID": "eag7cdo9-o09l-9i83-9dO9-f0b23oe78db4",
    "AuthenticationKey": "cOrXoK/1D35w8YQ8nH1/8ZGwzz45JIYD5jxHKXEQknk=",
    "TenantID": "34ddc78d-4fel-2358-8cc1-df84c8o839f5"
  },
  "ComposeSyntaxMaxVersion": "3.8",
  "ContainerEngine": "docker",
  "Edge": {
    "CommandInterval": 60,
    "PingInterval": 60,
    "SnapshotInterval": 60
  },
  "EdgeCheckinInterval": 5,
  "Gpus": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "GroupId": 1,
  "Heartbeat": true,
  "Id": 1,
  "Name": "my-environment",
  "PublicURL": "docker.mydomain.tld:2375",
  "SecuritySettings": {
    "allowContainerCapabilitiesForRegularUsers": true,
    "allowDeviceMappingForRegularUsers": true,
    "allowHostNamespaceForRegularUsers": true,
    "allowSecurityOptForRegularUsers": true,
    "allowStackManagementForRegularUsers": true,
    "allowSysctlSettingForRegularUsers": true,
    "allowVolumeBrowserForRegularUsers": true,
    "enableHostManagementFeatures": true
  },
  "TLSConfig": {
    "TLS": true,
    "TLSCACert": "/data/tls/ca.pem",
    "TLSCert": "/data/tls/cert.pem",
    "TLSKey": "/data/tls/key.pem"
  },
  "URL": "docker.mydomain.tld:2375"
}