edge_agent

Get environment status

Endpoint for edge agent to check status of environment Access policy: Edge agent only — requires X-PortainerAgent-EdgeID header

get/endpoints/{id}/edge/status

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/endpoints/{id}/edge/status
  • Auth
    • API key in header X-API-KEY
    • or API key in header Authorization

Path parameters

idinteger required

Environment identifier

Response

Success

Changes

No recorded changes to this operation across all 21 revisions of this API.