---
title: "List environments(endpoints)"
method: GET
path: "/endpoints"
tags: ["endpoints"]
---

# List environments(endpoints)

`GET /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

## Query parameters

- `start` integer
- `limit` integer
- `sort` 'Name' | 'Group' | 'Status' | 'LastCheckIn' | 'EdgeID' | 'PlatformType' | 'Health' | 'Id'
- `order` string
- `search` string
- `groupIds` integer[]
- `status` integer[]
- `types` integer[]
- `platformTypes` integer[]
- `outdated` boolean
- `excludeGroupIds` integer[]
- `tagIds` integer[]
- `tagsPartialMatch` boolean
- `endpointIds` integer[]
- `excludeIds` integer[]
- `agentVersions` string[]
- `edgeAsync` boolean
- `edgeDeviceUntrusted` boolean
- `edgeCheckInPassedSeconds` number
- `excludeSnapshots` boolean
- `name` string
- `edgeStackId` integer
- `edgeStackStatus` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13
- `edgeGroupIds` integer[]
- `excludeEdgeGroupIds` integer[]

## Response `200`

Endpoints

- PortainerEndpoint[]
  - `Agent` PortainerEnvironmentAgentData, required
    - `Version` string
  - `AzureCredentials` PortainerAzureCredentials
    - `ApplicationID` string, required — Azure application ID
    - `AuthenticationKey` string, required — Azure authentication key
    - `TenantID` string, required — Azure tenant ID
  - `ComposeSyntaxMaxVersion` string, required — Maximum version of docker-compose
  - `ContainerEngine` string, required — ContainerEngine represents the container engine type. This can be 'docker' or 'podman' when interacting directly with these environments, otherwise '' for kubernetes environments.
  - `Edge` PortainerEnvironmentEdgeSettings, required
    - `AsyncMode` boolean, required — Whether the device has been started in edge async mode
    - `CommandInterval` integer, required — The command list interval for edge agent - used in edge async mode [seconds]
    - `PingInterval` integer, required — The ping interval for edge agent - used in edge async mode [seconds]
    - `SnapshotInterval` integer, required — The snapshot interval for edge agent - used in edge async mode [seconds]
  - `EdgeCheckinInterval` integer, required — The check in interval for edge agent (in seconds)
  - `EdgeID` string — The identifier of the edge agent associated with this environment(endpoint)
  - `EdgeKey` string, required — The key which is used to map the agent to Portainer
  - `EnableGPUManagement` boolean
  - `Gpus` PortainerPair[]
    - `name` string, required
    - `value` string, required
  - `GroupId` integer, required — Environment(Endpoint) group identifier
  - `Heartbeat` boolean — Heartbeat indicates the heartbeat status of an edge environment
  - `Id` integer, required — Environment(Endpoint) Identifier
  - `Kubernetes` PortainerKubernetesData, required
    - `Configuration` PortainerKubernetesConfiguration, required
      - `AllowNoneIngressClass` boolean, required
      - `EnableResourceOverCommit` boolean
      - `IngressAvailabilityPerNamespace` boolean, required
      - `IngressClasses` PortainerKubernetesIngressClassConfig[]
        - `Blocked` boolean
        - `BlockedNamespaces` string[]
        - `Name` string, required
        - `Type` string, required
      - `ResourceOverCommitPercentage` integer
      - `RestrictDefaultNamespace` boolean
      - `StorageClasses` PortainerKubernetesStorageClassConfig[]
        - `AccessModes` string[]
        - `AllowVolumeExpansion` boolean, required
        - `Name` string, required
        - `Provisioner` string, required
      - `UseLoadBalancer` boolean
      - `UseServerMetrics` boolean
    - `Flags` PortainerKubernetesFlags, required
      - `GPUOperator` boolean
      - `IsServerIngressClassDetected` boolean, required
      - `IsServerMetricsDetected` boolean, required
      - `IsServerStorageDetected` boolean, required
    - `Snapshots` PortainerKubernetesSnapshot[]
      - `ClusterType` string
      - `DiagnosticsData` PortainerDiagnosticsData
        - `DNS` object
        - `Log` string
        - `Proxy` object
        - `Telnet` object
      - `GPUNodeCount` integer
      - `KubernetesVersion` string, required
      - `NodeCount` integer, required
      - `PerformanceMetrics` PortainerPerformanceMetrics
        - `CPUUsage` number
        - `DiskUsage` number
        - `MemoryUsage` number
        - `NetworkUsage` number
      - `Time` integer, required
      - `TotalCPU` integer, required
      - `TotalGPU` object
      - `TotalMemory` integer, required
  - `LastCheckInDate` integer, required — LastCheckInDate mark last check-in date on checkin
  - `Name` string, required — Environment(Endpoint) name
  - `PublicURL` string, required — URL or IP address where exposed containers will be reachable
  - `SecuritySettings` PortainerEndpointSecuritySettings, required
    - `allowBindMountsForRegularUsers` boolean, required — Whether non-administrator should be able to use bind mounts when creating containers
    - `allowContainerCapabilitiesForRegularUsers` boolean, required — Whether non-administrator should be able to use container capabilities
    - `allowDeviceMappingForRegularUsers` boolean, required — Whether non-administrator should be able to use device mapping
    - `allowHostNamespaceForRegularUsers` boolean, required — Whether non-administrator should be able to use the host pid
    - `allowPrivilegedModeForRegularUsers` boolean, required — Whether non-administrator should be able to use privileged mode when creating containers
    - `allowSecurityOptForRegularUsers` boolean, required — Whether non-administrator should be able to use security-opt settings
    - `allowStackManagementForRegularUsers` boolean, required — Whether non-administrator should be able to manage stacks
    - `allowSysctlSettingForRegularUsers` boolean, required — Whether non-administrator should be able to use sysctl settings
    - `allowVolumeBrowserForRegularUsers` boolean, required — Whether non-administrator should be able to browse volumes
    - `enableHostManagementFeatures` boolean, required — Whether host management features are enabled
  - `Snapshots` PortainerDockerSnapshot[] — List of snapshots
    - `ContainerCount` integer, required
    - `DiagnosticsData` PortainerDiagnosticsData
      - `DNS` object
      - `Log` string
      - `Proxy` object
      - `Telnet` object
    - `DockerSnapshotRaw` PortainerDockerSnapshotRaw
    - `DockerVersion` string, required
    - `GpuUseAll` boolean, required
    - `GpuUseList` string[]
    - `HealthyContainerCount` integer, required
    - `ImageCount` integer, required
    - `IsPodman` boolean, required
    - `NodeCount` integer, required
    - `PerformanceMetrics` PortainerPerformanceMetrics
      - `CPUUsage` number
      - `DiskUsage` number
      - `MemoryUsage` number
      - `NetworkUsage` number
    - `RunningContainerCount` integer, required
    - `ServiceCount` integer, required
    - `StackCount` integer, required
    - `StoppedContainerCount` integer, required
    - `Swarm` boolean, required
    - `Time` integer, required
    - `TotalCPU` integer, required
    - `TotalMemory` integer, required
    - `UnhealthyContainerCount` integer, required
    - `VolumeCount` integer, required
  - `Status` 0 | 1 | 2
  - `TLSConfig` PortainerTLSConfiguration, required
    - `TLS` boolean, required — Use TLS
    - `TLSCACert` string — Path to the TLS CA certificate file
    - `TLSCert` string — Path to the TLS client certificate file
    - `TLSKey` string — Path to the TLS client key file
    - `TLSSkipVerify` boolean, required — Skip the verification of the server TLS certificate
  - `TagIds` integer[] — List of tag identifiers to which this environment(endpoint) is associated
  - `TeamAccessPolicies` PortainerTeamAccessPolicies
  - `Type` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7, required
  - `URL` string, required — URL or IP address of the Docker host associated to this environment(endpoint)
  - `UserAccessPolicies` PortainerUserAccessPolicies
  - `UserTrusted` boolean — Whether the device has been trusted or not by the user

## Other responses

- `500` — Server error

---

[API](https://skmtc.net/portainer/apis/portainerce-api.md) · [All operations](https://skmtc.net/portainer/apis/portainerce-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/portainer/portainerce-api/versions/c0b0975cd11b/schema)