Sign in
Edge

Create an Edge session and initial execution

Changed on

EDGE-060 — supports Idempotency-Key. A retry with the same key and identical body returns the SAME session_id / execution_id / trace_id (cached replay, 201). A retry with the same key but different body returns 409 idempotency_conflict. Missing key falls back to non-idempotent behavior (every call generates fresh UUIDs).

post/api/v1/edge/sessions

Request

  • Base URL: http://localhost:8081
  • URL: http://localhost:8081/api/v1/edge/sessions
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Headers

X-Tenant-IDstring required

Tenant isolation header (required on all protected routes).

Idempotency-Keystring uuid

Optional idempotency key for safe retries. Edge event create/batch scopes keys by tenant and endpoint, replays the first response for the same normalized request, and returns 409 idempotency_conflict if the same key is reused with a different normalized request. Callers SHOULD send a UUID (per the original Job submit contract); the Edge runtime additionally accepts any non-empty string up to 512 bytes for backward-compatible local-dev keys.

Request body

tenant_idstring

Optional body tenant; when present it must match X-Tenant-ID.

principal_idstring
principal_type'human' | 'service' | 'unknown'
agent_productstring
agent_versionstring
mode'local-dev' | 'enterprise-managed' | 'workflow' | 'ci' | 'prod-runner'
repostring
git_remotestring
git_branchstring
git_shastring
cwdstring
host_idstring
device_idstring
trace_idstring
workflow_run_idstring
job_idstring
policy_snapshotstring

Redacted policy snapshot identifier or summary; raw secrets are redacted before persistence/response.

enforcement_layersEdgeEnforcementLayers
policy_mode'observe' | 'enforce' | 'enterprise-strict'
labelsEdgeLabels

Response

Edge session created

session_idstring required
execution_idstring required
trace_idstring required
policy_snapshotstring required

Redacted policy snapshot identifier or summary; raw secrets are redacted before persistence/response.

dashboard_urlstring required

Relative dashboard URL for the Edge session.

Changes

  • 12120aad0bfeRevision changes
    • warning

      added the new limit_exceeded enum value to the response property for the response status

    • warning

      added the new limit_exceeded enum value to the response property for the response status

    • warning

      added the new limit_exceeded enum value to the response property for the response status

    • warning

      added the new limit_exceeded enum value to the response property for the response status

    • warning

      added the new limit_exceeded enum value to the response property for the response status

    • warning

      added the new limit_exceeded enum value to the response property for the response status

    • warning

      added the new limit_exceeded enum value to the response property for the response status

    • warning

      added the new limit_exceeded enum value to the response property for the response status

    • warning

      added the new replay_window_full enum value to the response property for the response status

    • warning

      added the new replay_window_full enum value to the response property for the response status

    • warning

      added the new replay_window_full enum value to the response property for the response status

    • warning

      added the new replay_window_full enum value to the response property for the response status

    • warning

      added the new replay_window_full enum value to the response property for the response status

    • warning

      added the new replay_window_full enum value to the response property for the response status

    • warning

      added the new replay_window_full enum value to the response property for the response status

    • warning

      added the new replay_window_full enum value to the response property for the response status

    • warning

      added the new step_up_required enum value to the response property for the response status

    • warning

      added the new step_up_required enum value to the response property for the response status

    • warning

      added the new step_up_required enum value to the response property for the response status

    • warning

      added the new step_up_required enum value to the response property for the response status

    • warning

      added the new step_up_required enum value to the response property for the response status

    • warning

      added the new step_up_required enum value to the response property for the response status

    • warning

      added the new step_up_required enum value to the response property for the response status

    • warning

      added the new step_up_required enum value to the response property for the response status

  • 9f66383d6e95Revision changes
    • info

      endpoint added