v13

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

endpoints

List environments(endpoints)

List all environments(endpoints) based on the current user authorizations. Will return all environments(endpoints) if using an administrator or team leader account otherwise it will only return authorized environments(endpoints). Access policy: restricted

get/endpoints

Query parameters

startinteger

Start searching from

limitinteger

Limit results to this value

Sort results by this value

orderstring

Order sorted results by desc/asc

searchstring

Search query

groupIdsinteger[]

List environments(endpoints) of these groups

statusinteger[]

List environments(endpoints) by this status

typesinteger[]

List environments(endpoints) of this type

platformTypesinteger[]

Filter environments by platform type

outdatedboolean

If true, return only environments with an outdated agent

excludeGroupIdsinteger[]

Exclude environments of these groups

tagIdsinteger[]

search environments(endpoints) with these tags (depends on tagsPartialMatch)

tagsPartialMatchboolean

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

endpointIdsinteger[]

will return only these environments(endpoints)

excludeIdsinteger[]

will exclude these environments(endpoints)

agentVersionsstring[]

will return only environments with on of these agent versions

edgeAsyncboolean

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)

edgeDeviceUntrustedboolean

if true, show only untrusted edge agents, if false show only trusted edge agents (relevant only for edge agents)

edgeCheckInPassedSecondsnumber

if bigger then zero, show only edge agents that checked-in in the last provided seconds (relevant only for edge agents)

excludeSnapshotsboolean

if true, the snapshot data won't be retrieved

namestring

will return only environments(endpoints) with this name

edgeStackIdinteger

will return the environments of the specified edge stack

edgeStackStatus0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13

only applied when edgeStackId exists. Filter the returned environments based on their deployment status in the stack (not the environment status!)

edgeGroupIdsinteger[]

List environments(endpoints) of these edge groups

excludeEdgeGroupIdsinteger[]

Exclude environments(endpoints) of these edge groups

Response

Endpoints

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"
  }
]