Public docs

App API — Partners

Upload and manage your partner map.

Phase 1 shell: this docs surface is wired to the existing backend and repo documentation, and will be expanded as the private dashboard comes online.

What the partner map is

The partner map is a list of your customers and partners with the API scopes or permissions they use. opSentry uses this to auto-match impacted partners when an alert or changelog comes in.

---

GET /partners/list/{workspace_id}

Returns all partner rows for the workspace, with their column names.

Response:

{
  "success": true,
  "columns": ["Partner", "Scopes", "Area", "Status"],
  "rows": [...]
}

---

POST /partners/upload-csv

Upload a partner list from CSV text. Replaces any existing dataset.

Request body

{
  "workspace_id": 1,
  "csv_text": "Partner,Scopes,Area,Status\nNorthstar Bank,auth:legacy,Auth,active"
}

The CSV must include a header row. Column names are flexible — opSentry uses aliases to detect partner name, scopes, area, and status.

---

POST /partners/upload-json

Upload a partner list from JSON rows. Replaces any existing dataset.

Request body

{
  "workspace_id": 1,
  "rows": [
    { "partner_name": "Northstar Bank", "scopes": "auth:legacy", "area": "Auth", "status": "active" }
  ]
}

---

POST /partners/create-row (POST /partners/create)

Add a single row to the existing dataset. The active dataset must exist first.

Request body

{
  "workspace_id": 1,
  "row_data": { "Partner": "New Corp", "Scopes": "billing:read", "Area": "Billing" }
}

---

DELETE /partners/delete/{row_id}

Delete a single partner row by its ID.

---

DELETE /partners/reset/{workspace_id}

Delete all partner rows and deactivate the current dataset. Use before uploading a replacement.

---

Column aliasing

opSentry automatically recognizes common column names:

  • Partner name: partner_name, name, customer, account, company, client, org
  • Scopes: scopes, scope, permissions, oauth_scopes, api_scopes
  • Area: area, product_area, domain, service, team
  • Status: status, state, health, condition
Upload a partner CSV
curl -X POST https://api.opsentry.ai/partners/upload-csv \
-H "Content-Type: application/json" \
-d '{
"workspace_id": 1,
"csv_text": "Partner,Scopes,Area,Status\nNorthstar Bank,auth:legacy,Auth,active\nApex Solutions,billing:read,Billing,active"
}'