Get organization policy rollout status

GET /api/v1/organizations/{id}/policies/rollout

Reports whether every project in the organization is running the latest platform policy generation, separating projects the gateway has not yet materialized from projects the data plane has not yet acknowledged.

Path parameters

id string Required

Organization ID

Responses

406

application/json

application/json application/vnd.agent-engine-2026-09-20-preview+json

Unsupported or malformed API version, an operation unavailable in the selected published contract, or an unacceptable representation (including unsupported media-type parameters or excluded SSE). Existing authentication, authorization, and rate-limit failures take precedence.
Hide response attributes Show response attributes object
- badRequestDetail object
  
  Optional validation details defined by the standard error schema; API negotiation errors do not emit this field.
  
  Hide badRequestDetail attribute Show badRequestDetail attribute object
  
  fields array[object]
  
  Fields with validation failures.
  
  Hide fields attributes Show fields attributes object
  
  A field and its validation failure.
  
  description string Required
  
  Human-readable validation failure.
  
  field string Required
  
  Name or path of the invalid request field.
- detail string Required
  
  Human-readable error details.
- error integer Required
  
  HTTP status code.
- errorCode string Required
  
  Machine-readable error code.
- parameters array[string]
  
  Request parameter names associated with the error; omitted when none apply.
- reason string Required
  
  HTTP status reason phrase.
Hide response attributes Show response attributes object
- badRequestDetail object
  
  Optional validation details defined by the standard error schema; API negotiation errors do not emit this field.
  
  Hide badRequestDetail attribute Show badRequestDetail attribute object
  
  fields array[object]
  
  Fields with validation failures.
  
  Hide fields attributes Show fields attributes object
  
  A field and its validation failure.
  
  description string Required
  
  Human-readable validation failure.
  
  field string Required
  
  Name or path of the invalid request field.
- detail string Required
  
  Human-readable error details.
- error integer Required
  
  HTTP status code.
- errorCode string Required
  
  Machine-readable error code.
- parameters array[string]
  
  Request parameter names associated with the error; omitted when none apply.
- reason string Required
  
  HTTP status reason phrase.
200

application/vnd.agent-engine-2026-09-20-preview+json

application/vnd.agent-engine-2026-09-20-preview+json application/json

OK
Hide response attributes Show response attributes object
- converged integer
- dead_lettered integer
- lagging_projects array[object]
  
  LaggingProjects samples the projects behind the latest generation, capped at policyRolloutLaggingProjectLimit. Truncated reports whether the sample is partial.
  
  Hide lagging_projects attributes Show lagging_projects attributes object
  
  attempts integer
  
  dead_lettered boolean
  
  failure_kind string
  
  FailureKind is a stable classification, not the raw cause. The underlying error can carry driver and infrastructure detail and this route is reachable by any org member, so the raw text stays on the document and in logs for operators.
  
  generation integer
  
  Generation is the latest materialized runtime generation for the project, and ReceivedGeneration is the newest one ECP has acknowledged. They differ while a change is in flight to the data plane.
  
  project_id string
  
  reason string
  
  received_generation integer
- missing_config integer
  
  MissingConfig counts active projects with no runtime config at all. Expected when the org has no policies (there is nothing to materialize); otherwise it is a gap, which is why it is reported rather than folded into Converged.
- org_id string
- pending_materialization integer
- pending_publish integer
- projects_total integer
  
  ProjectsTotal counts the org's active projects, not its runtime-config rows, so a project that has never materialized still shows up in the denominator.
- truncated boolean
Hide response attributes Show response attributes object
- converged integer
- dead_lettered integer
- lagging_projects array[object]
  
  LaggingProjects samples the projects behind the latest generation, capped at policyRolloutLaggingProjectLimit. Truncated reports whether the sample is partial.
  
  Hide lagging_projects attributes Show lagging_projects attributes object
  
  attempts integer
  
  dead_lettered boolean
  
  failure_kind string
  
  FailureKind is a stable classification, not the raw cause. The underlying error can carry driver and infrastructure detail and this route is reachable by any org member, so the raw text stays on the document and in logs for operators.
  
  generation integer
  
  Generation is the latest materialized runtime generation for the project, and ReceivedGeneration is the newest one ECP has acknowledged. They differ while a change is in flight to the data plane.
  
  project_id string
  
  reason string
  
  received_generation integer
- missing_config integer
  
  MissingConfig counts active projects with no runtime config at all. Expected when the org has no policies (there is nothing to materialize); otherwise it is a gap, which is why it is reported rather than folded into Converged.
- org_id string
- pending_materialization integer
- pending_publish integer
- projects_total integer
  
  ProjectsTotal counts the org's active projects, not its runtime-config rows, so a project that has never materialized still shows up in the denominator.
- truncated boolean
400

application/json

application/json application/vnd.agent-engine-2026-09-20-preview+json

Bad Request
Hide response attributes Show response attributes object
- code string
- error string
- success boolean
Hide response attributes Show response attributes object
- code string
- error string
- success boolean
403

application/json

application/json application/vnd.agent-engine-2026-09-20-preview+json

Forbidden
Hide response attributes Show response attributes object
- code string
- error string
- success boolean
Hide response attributes Show response attributes object
- code string
- error string
- success boolean
500

application/json

application/json application/vnd.agent-engine-2026-09-20-preview+json

Internal Server Error
Hide response attributes Show response attributes object
- code string
- error string
- success boolean
Hide response attributes Show response attributes object
- code string
- error string
- success boolean

GET /api/v1/organizations/{id}/policies/rollout

curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/organizations/{id}/policies/rollout' \
 --header "Authorization: $API_KEY"

Response examples (406)

{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}

{
  "detail": "This operation supports text/event-stream, which the Accept header excludes. Remove unsupported media-type parameters or accept this type with a positive q value.",
  "error": 406,
  "errorCode": "UNACCEPTABLE_MEDIA_TYPE",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}

{
  "detail": "The requested API version is not supported. Supported versions: 2026-09-20-preview.",
  "error": 406,
  "errorCode": "UNSUPPORTED_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}

Response examples (406)

{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}

Response examples (200)

{
  "converged": 42,
  "dead_lettered": 42,
  "lagging_projects": [
    {
      "attempts": 42,
      "dead_lettered": true,
      "failure_kind": "string",
      "generation": 42,
      "project_id": "string",
      "reason": "string",
      "received_generation": 42
    }
  ],
  "missing_config": 42,
  "org_id": "string",
  "pending_materialization": 42,
  "pending_publish": 42,
  "projects_total": 42,
  "truncated": true
}

Response examples (200)

{
  "converged": 42,
  "dead_lettered": 42,
  "lagging_projects": [
    {
      "attempts": 42,
      "dead_lettered": true,
      "failure_kind": "string",
      "generation": 42,
      "project_id": "string",
      "reason": "string",
      "received_generation": 42
    }
  ],
  "missing_config": 42,
  "org_id": "string",
  "pending_materialization": 42,
  "pending_publish": 42,
  "projects_total": 42,
  "truncated": true
}

Response examples (400)

{
  "code": "string",
  "error": "string",
  "success": true
}

Response examples (400)

{
  "code": "string",
  "error": "string",
  "success": true
}

Response examples (403)

{
  "code": "string",
  "error": "string",
  "success": true
}

Response examples (403)

{
  "code": "string",
  "error": "string",
  "success": true
}

Response examples (500)

{
  "code": "string",
  "error": "string",
  "success": true
}

Response examples (500)

{
  "code": "string",
  "error": "string",
  "success": true
}