---
title: "Org-level private-agent setup: o2syn_ token + docker install template"
method: GET
path: "/api/{org_id}/synthetics/agent-setup"
tags: ["Synthetics"]
---

# Org-level private-agent setup: o2syn_ token + docker install template

`GET /api/{org_id}/synthetics/agent-setup`

## Request

- Base URL: `https://api.openobserve.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.openobserve.ai/api/{org_id}/synthetics/agent-setup`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/openobserve/apis/openobserve-api-http/docs/api/:org_id/synthetics/agent-setup/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `org_id` string, required

## Response `200`

Success

- AgentSetupResponse: Org-level agent setup for the drawer: the org's `o2syn_` token plus the ingredients the UI composes per-platform install commands from (the location name is typed client-side, so the server returns parts, not a finished command). Private locations are deploy-declared (`AGENT_LOCATION`), so setup is org-level — the location row is upserted at first register.
  - `install` string, required: Legacy docker one-liner (kept while the drawer migrates to composed per-platform commands).
  - `o2_url` string, required: Probe-facing base URL (`AGENT_POLL_ENDPOINT`).
  - `org` string, required: Org the probe scopes its Job API calls to (`AGENT_ORG`, in the URL path).
  - `script_url` string, required: Public install script the composed commands pipe to bash.
  - `token` string, nullable

## Other responses

- `500`: Error

---

[API](https://skmtc.dev/openobserve/apis/openobserve-api-http.md) - [All operations](https://skmtc.dev/openobserve/apis/openobserve-api-http/llms.txt) - [OpenAPI document](https://skmtc.dev/openobserve/apis/openobserve-api-http/revisions/0529b8a10252?raw)