# Merge progress and retries Source: https://neondeerdata.com/docs/api/duplicate-detection/executions/ Follow merge outcomes, cancel remaining work, or prepare a retry plan. The APIs on this page require alpha access for your organization. App availability and API access are separate. [Check access and permissions](https://neondeerdata.com/docs/api/permissions/). ## List executions ```http GET /v1/deduplication/executions ``` Lists merge executions, one page at a time. Requires `dedupe:read`. The connection also needs access to the relevant tables, objects, or workflows. MCP action: `list_dedupe_merge_executions`. Its argument names match the fields below; an HTTP header is passed using its argument name in MCP. ### Parameters | Name | Send in | Required | Type or allowed values | Notes | | ------------------- | ------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | | `object_type` | query | No | `"companies"`, `"people"` | | | `status` | query | No | array of `"queued"`, `"holding"`, `"preparing_recovery"`, `"running"`, `"waiting"`, `"cancel_requested"`, `"needs_attention"`, `"succeeded"`, `"partially_succeeded"`, `"failed"`, `"canceled"` | Repeat this query parameter for multiple values. | | `plan_id` | query | No | string | | | `created_at_from` | query | No | string (date-time) | | | `created_at_before` | query | No | string (date-time) | | | `ended_at_from` | query | No | string (date-time) | | | `ended_at_before` | query | No | string (date-time) | | | `sort` | query | No | `"-created_at"`, `"created_at"` | | | `limit` | query | No | integer | | | `cursor` | query | No | string | | ### Response | HTTP status | Result | | ----------- | --------------------------------------------------------------------- | | `200` | The requested result. Asynchronous work returns an operation to poll. | Required fields are required within their containing object. Notes identify fields that apply only to a particular response alternative. | Response field | Type | Required in object | Notes | | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- | | `data` | array of object | Yes | | | `data[].object` | `"deduplication_execution"` | Yes | | | `data[].id` | string | Yes | | | `data[].version` | string | Yes | | | `data[].plan_id` | string | Yes | | | `data[].revision` | string | Yes | | | `data[].object_type` | `"companies"`, `"people"` | Yes | | | `data[].status` | `"queued"`, `"holding"`, `"preparing_recovery"`, `"running"`, `"waiting"`, `"cancel_requested"`, `"needs_attention"`, `"succeeded"`, `"partially_succeeded"`, `"failed"`, `"canceled"` | Yes | | | `data[].reason_code` | string or null | Yes | | | `data[].execute_not_before` | string (date-time) | Yes | | | `data[].authorization_expires_at` | string (date-time) | Yes | | | `data[].items` | object | Yes | | | `data[].items.not_started` | integer | Yes | | | `data[].items.applied` | integer | Yes | | | `data[].items.not_applied` | integer | Yes | | | `data[].items.unknown` | integer | Yes | | | `data[].items.canceled` | integer | Yes | | | `data[].cancel_requested_at` | string (date-time) or null | Yes | | | `data[].reconciliation_deadline` | string (date-time) or null | Yes | | | `data[].backup_available` | boolean | Yes | | | `data[].created_at` | string (date-time) | Yes | | | `data[].ended_at` | string (date-time) or null | Yes | | | `pagination` | object | Yes | | | `pagination.next_cursor` | string or null | Yes | | ### Errors | HTTP status | Meaning | | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | `400` | One of: credential_in_url, invalid_parameter, unknown_parameter, invalid_request, invalid_cursor. | | `401` | One of: missing_credential, invalid_credential, credential_expired, credential_revoked. | | `402` | One of: payment_overdue. | | `403` | The current permissions, plan or policy do not allow this request. | | `404` | One of: not_found. | | `409` | The request conflicts with current resource state, authorization or an earlier request. Read the error code and current resource before retrying. | | `410` | The requested resource or retained recovery data has expired. | | `412` | One of: version_conflict. | | `413` | One of: request_too_large. | | `422` | A field, filter or selection cannot be used for this request. | | `423` | One of: organization_reopening. | | `428` | One of: customer_agreement_required. | | `429` | One of: rate_limited. | | `503` | One of: service_unavailable. | See [errors and recovery](https://neondeerdata.com/docs/api/errors/) and [safe retries](https://neondeerdata.com/docs/api/requests/) before repeating a write. ## Get execution ```http GET /v1/deduplication/executions/{execution_id} ``` Gets a merge execution's progress: how many merges were applied, not applied, unknown and canceled. A merge that was sent but whose result is not yet known stays open until it is confirmed, even after a cancel. When only part of the plan merged, the answer says so. Requires `dedupe:read`. The connection also needs access to the relevant tables, objects, or workflows. MCP action: `get_dedupe_merge_execution`. Its argument names match the fields below; an HTTP header is passed using its argument name in MCP. ### Parameters | Name | Send in | Required | Type or allowed values | Notes | | -------------- | ------- | -------- | ---------------------- | ----- | | `execution_id` | path | Yes | string | | ### Response | HTTP status | Result | | ----------- | --------------------------------------------------------------------- | | `200` | The requested result. Asynchronous work returns an operation to poll. | Required fields are required within their containing object. Notes identify fields that apply only to a particular response alternative. | Response field | Type | Required in object | Notes | | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- | | `data` | object | Yes | | | `data.object` | `"deduplication_execution"` | Yes | | | `data.id` | string | Yes | | | `data.version` | string | Yes | | | `data.plan_id` | string | Yes | | | `data.revision` | string | Yes | | | `data.object_type` | `"companies"`, `"people"` | Yes | | | `data.status` | `"queued"`, `"holding"`, `"preparing_recovery"`, `"running"`, `"waiting"`, `"cancel_requested"`, `"needs_attention"`, `"succeeded"`, `"partially_succeeded"`, `"failed"`, `"canceled"` | Yes | | | `data.reason_code` | string or null | Yes | | | `data.execute_not_before` | string (date-time) | Yes | | | `data.authorization_expires_at` | string (date-time) | Yes | | | `data.items` | object | Yes | | | `data.items.not_started` | integer | Yes | | | `data.items.applied` | integer | Yes | | | `data.items.not_applied` | integer | Yes | | | `data.items.unknown` | integer | Yes | | | `data.items.canceled` | integer | Yes | | | `data.cancel_requested_at` | string (date-time) or null | Yes | | | `data.reconciliation_deadline` | string (date-time) or null | Yes | | | `data.backup_available` | boolean | Yes | | | `data.created_at` | string (date-time) | Yes | | | `data.ended_at` | string (date-time) or null | Yes | | ### Errors | HTTP status | Meaning | | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | `400` | One of: credential_in_url, invalid_parameter, unknown_parameter. | | `401` | One of: missing_credential, invalid_credential, credential_expired, credential_revoked. | | `402` | One of: payment_overdue. | | `403` | The current permissions, plan or policy do not allow this request. | | `404` | One of: not_found. | | `409` | The request conflicts with current resource state, authorization or an earlier request. Read the error code and current resource before retrying. | | `410` | The requested resource or retained recovery data has expired. | | `412` | One of: version_conflict. | | `413` | One of: request_too_large. | | `422` | A field, filter or selection cannot be used for this request. | | `423` | One of: organization_reopening. | | `428` | One of: customer_agreement_required. | | `429` | One of: rate_limited. | | `503` | One of: service_unavailable. | See [errors and recovery](https://neondeerdata.com/docs/api/errors/) and [safe retries](https://neondeerdata.com/docs/api/requests/) before repeating a write. ## Get execution items ```http GET /v1/deduplication/executions/{execution_id}/items ``` Lists the outcome of each merge in an execution, one page at a time. Requires `dedupe:read`. The connection also needs access to the relevant tables, objects, or workflows. MCP action: `list_dedupe_merge_execution_items`. Its argument names match the fields below; an HTTP header is passed using its argument name in MCP. ### Parameters | Name | Send in | Required | Type or allowed values | Notes | | -------------- | ------- | -------- | --------------------------------------------------------------------------------- | ------------------------------------------------ | | `execution_id` | path | Yes | string | | | `outcome` | query | No | array of `"not_started"`, `"applied"`, `"not_applied"`, `"unknown"`, `"canceled"` | Repeat this query parameter for multiple values. | | `limit` | query | No | integer | | | `cursor` | query | No | string | | ### Response | HTTP status | Result | | ----------- | --------------------------------------------------------------------- | | `200` | The requested result. Asynchronous work returns an operation to poll. | Required fields are required within their containing object. Notes identify fields that apply only to a particular response alternative. | Response field | Type | Required in object | Notes | | ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ------------------ | -------------- | | `data` | array of object | Yes | | | `data[].object` | `"deduplication_execution_item"` | Yes | | | `data[].id` | string | Yes | | | `data[].position` | integer | Yes | | | `data[].set_id` | string | Yes | | | `data[].keeper_record_id` | string | Yes | | | `data[].merge_record_id` | string | Yes | | | `data[].outcome` | `"not_started"`, `"applied"`, `"not_applied"`, `"unknown"`, `"canceled"` | Yes | | | `data[].reason_code` | string or null | Yes | | | `data[].output_record_id` | string or null | Yes | | | `data[].recovery` | array of object | Yes | | | `data[].recovery[].record_id` | string | Yes | | | `data[].recovery[].role` | `"keeper"`, `"merged"` | Yes | | | `data[].recovery[].field_values` | object or null | Yes | | | `data[].recovery[].field_values.captured_at` | string (date-time) | Yes | Alternative 1. | | `data[].recovery[].field_values.expires_at` | string (date-time) | Yes | Alternative 1. | | `data[].recovery[].field_values.content_available` | boolean | Yes | Alternative 1. | | `data[].recovery[].related` | object or null | Yes | | | `data[].recovery[].related.captured_at` | string (date-time) | Yes | Alternative 1. | | `data[].recovery[].related.expires_at` | string (date-time) | Yes | Alternative 1. | | `data[].recovery[].related.content_available` | boolean | Yes | Alternative 1. | | `data[].recovery[].related.categories` | array of object | Yes | Alternative 1. | | `data[].recovery[].related.categories[].category` | `"list_entries"`, `"comments"`, `"notes"`, `"files"`, `"meetings"`, `"call_recordings"`, `"incoming_references"` | Yes | Alternative 1. | | `data[].recovery[].related.categories[].state` | `"complete"`, `"empty"`, `"not_granted"`, `"failed"` | Yes | Alternative 1. | | `data[].ended_at` | string (date-time) or null | Yes | | | `pagination` | object | Yes | | | `pagination.next_cursor` | string or null | Yes | | | `references` | array of object | Yes | | | `references[].provider` | `"attio"` | Yes | | | `references[].workspace_id` | string or null | Yes | | | `references[].object_id` | string or null | Yes | | | `references[].object_slug` | string or null | Yes | | | `references[].records` | array of object | Yes | | | `references[].records[].record_id` | string | Yes | | | `references[].records[].web_url` | string (uri) or null | Yes | | | `references[].records[].attributes` | array of object | Yes | | | `references[].records[].attributes[].attribute_id` | string or null | Yes | | | `references[].records[].attributes[].attribute_slug` | string or null | Yes | | | `references[].records[].via` | array of object | Yes | | | `references[].records[].via[].source_object_id` | string or null | Yes | | | `references[].records[].via[].source_object_slug` | string or null | Yes | | | `references[].records[].via[].source_record_id` | string | Yes | | | `references[].records[].via[].attribute_id` | string or null | Yes | | | `references[].records[].via[].attribute_slug` | string or null | Yes | | | `references[].records[].via[].target_object_id` | string or null | Yes | | | `references[].records[].via[].target_object_slug` | string or null | Yes | | | `references[].records[].via[].target_record_id` | string | Yes | | | `references[].lookup_hint` | object | Yes | | | `references[].lookup_hint.resource` | `"records"` | Yes | | | `references[].lookup_hint.object` | string | Yes | | | `references[].lookup_hint.record_ids` | array of string | Yes | | ### Errors | HTTP status | Meaning | | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | `400` | One of: credential_in_url, invalid_parameter, unknown_parameter, invalid_request, invalid_cursor. | | `401` | One of: missing_credential, invalid_credential, credential_expired, credential_revoked. | | `402` | One of: payment_overdue. | | `403` | The current permissions, plan or policy do not allow this request. | | `404` | One of: not_found. | | `409` | The request conflicts with current resource state, authorization or an earlier request. Read the error code and current resource before retrying. | | `410` | The requested resource or retained recovery data has expired. | | `412` | One of: version_conflict. | | `413` | One of: request_too_large. | | `422` | A field, filter or selection cannot be used for this request. | | `423` | One of: organization_reopening. | | `428` | One of: customer_agreement_required. | | `429` | One of: rate_limited. | | `503` | One of: service_unavailable. | See [errors and recovery](https://neondeerdata.com/docs/api/errors/) and [safe retries](https://neondeerdata.com/docs/api/requests/) before repeating a write. ## Cancel execution ```http POST /v1/deduplication/executions/{execution_id}/cancel ``` Stops the merges of an execution this key started that have not been sent yet. Send the execution's version as expected_version. Merges already applied stay applied, and a merge already sent stays open until its result is confirmed. The cancel's operation finishes once the cancel is recorded; the execution's own operation finishes when its merges settle. Needs no extra scope, but the key must still have access to the object. Requires an active connection. Access to existing work is checked against the connection that started it. MCP action: `cancel_dedupe_merge_execution`. Its argument names match the fields below; an HTTP header is passed using its argument name in MCP. ### Parameters | Name | Send in | Required | Type or allowed values | Notes | | ------------------ | ------------------------- | -------- | ---------------------- | ----- | | `execution_id` | path | Yes | string | | | `expected_version` | JSON body | Yes | string | | | `request_key` | Header: `Idempotency-Key` | Yes | string | | ### Response | HTTP status | Result | | ----------- | --------------------------------------------------------------------- | | `202` | The requested result. Asynchronous work returns an operation to poll. | Required fields are required within their containing object. Notes identify fields that apply only to a particular response alternative. | Response field | Type | Required in object | Notes | | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `data` | object | Yes | | | `data.id` | string | Yes | | | `data.object` | `"operation"` | Yes | | | `data.version` | string | Yes | | | `data.resource_id` | string | Yes | | | `data.resource_type` | string | Yes | | | `data.status` | `"pending"`, `"succeeded"`, `"failed"`, `"canceled"`, `"needs_attention"` | Yes | | | `data.terminal` | boolean | Yes | | | `data.created_at` | string (date-time) | Yes | | | `data.ended_at` | string (date-time) or null | Yes | | | `data.reason_code` | string or null | Yes | | | `data.replayed` | `true` | No | | | `data.operation_type` | `"scan_cancel"`, `"ai_assessment"`, `"ai_assessment_cancel"`, `"review_update"`, `"exclusion_create"`, `"exclusion_update"`, `"scheduled_batch_create"`, `"scheduled_batch_update"`, `"scheduled_batch_cancel"`, `"scheduled_run_cancel"`, `"scheduled_record_cancel"`, `"schedule_create"`, `"schedule_update"`, `"webhook_endpoint_create"`, `"webhook_endpoint_update"`, `"webhook_secret_rotate"`, `"endpoint_verification"`, `"webhook_replay"`, `"merge_rebuild"`, `"scheduled_batch_transfer"`, `"webhook_endpoint_transfer"` | Yes | When data.operation_type is `"scan_cancel"`, `"ai_assessment"`, `"ai_assessment_cancel"`, `"review_update"`, `"exclusion_create"`, `"exclusion_update"`, `"scheduled_batch_create"`, `"scheduled_batch_update"`, `"scheduled_batch_cancel"`, `"scheduled_run_cancel"`, `"scheduled_record_cancel"`, `"schedule_create"`, `"schedule_update"`, `"webhook_endpoint_create"`, `"webhook_endpoint_update"`, `"webhook_secret_rotate"`, `"endpoint_verification"`, `"webhook_replay"`, `"merge_rebuild"`, `"scheduled_batch_transfer"`, `"webhook_endpoint_transfer"`. | | `data.action_metadata` | object | Yes | | | `data.action_metadata.resource_version` | string | Yes | | | `data.action_metadata.allowed_actions` | array of string | Yes | | | `data.operation_type` | `"merge_execute"`, `"merge_cancel"` | Yes | When data.operation_type is `"merge_execute"`, `"merge_cancel"`. | | `data.action_metadata.execute_not_before` | string (date-time) | Yes | When data.operation_type is `"merge_execute"`, `"merge_cancel"`. | | `data.action_metadata.authorization_expires_at` | string (date-time) | Yes | When data.operation_type is `"merge_execute"`, `"merge_cancel"`. | | `data.operation_type` | `"plan_prepare"`, `"plan_revision_prepare"`, `"retry_plan_prepare"` | Yes | When data.operation_type is `"plan_prepare"`, `"plan_revision_prepare"`, `"retry_plan_prepare"`. | | `data.action_metadata.plan_revision` | string | Yes | When data.operation_type is `"plan_prepare"`, `"plan_revision_prepare"`, `"retry_plan_prepare"`. | | `data.action_metadata.effects_digest` | string or null | Yes | When data.operation_type is `"plan_prepare"`, `"plan_revision_prepare"`, `"retry_plan_prepare"`. | | `data.action_metadata.preview_digest` | string or null | Yes | When data.operation_type is `"plan_prepare"`, `"plan_revision_prepare"`, `"retry_plan_prepare"`. | | `data.action_metadata.recovery_coverage_digest` | string or null | Yes | When data.operation_type is `"plan_prepare"`, `"plan_revision_prepare"`, `"retry_plan_prepare"`. | | `data.action_metadata.authorization_requirement` | object | Yes | When data.operation_type is `"plan_prepare"`, `"plan_revision_prepare"`, `"retry_plan_prepare"`. | | `data.action_metadata.authorization_requirement.scope` | `"organization_baseline"` | Yes | When data.operation_type is `"plan_prepare"`, `"plan_revision_prepare"`, `"retry_plan_prepare"`. | | `data.action_metadata.authorization_requirement.mode` | `"api_key_allowed"`, `"not_allowed"` | Yes | When data.operation_type is `"plan_prepare"`, `"plan_revision_prepare"`, `"retry_plan_prepare"`. | | `data.action_metadata.authorization_requirement.policy_version` | string | Yes | When data.operation_type is `"plan_prepare"`, `"plan_revision_prepare"`, `"retry_plan_prepare"`. | | `data.action_metadata.authorization_requirement.grant_evaluation` | `"at_execution"` | Yes | When data.operation_type is `"plan_prepare"`, `"plan_revision_prepare"`, `"retry_plan_prepare"`. | | `data.action_metadata.authorization_requirement.reason_code` | string or null | Yes | When data.operation_type is `"plan_prepare"`, `"plan_revision_prepare"`, `"retry_plan_prepare"`. | | `data.action_metadata.authorization_state` | `"unauthorized"`, `"authorized"`, `"rejected"`, `"invalidated"`, `"expired"` | Yes | When data.operation_type is `"plan_prepare"`, `"plan_revision_prepare"`, `"retry_plan_prepare"`. | | `data.operation_type` | `"review_bulk_update"`, `"exclusion_bulk_create"` | Yes | When data.operation_type is `"review_bulk_update"`, `"exclusion_bulk_create"`. | | `data.action_metadata.results` | array of object | Yes | When data.operation_type is `"review_bulk_update"`, `"exclusion_bulk_create"`. | | `data.action_metadata.results[].index` | integer | Yes | When data.operation_type is `"review_bulk_update"`, `"exclusion_bulk_create"`. | | `data.action_metadata.results[].outcome` | `"succeeded"`, `"failed"` | Yes | When data.operation_type is `"review_bulk_update"`, `"exclusion_bulk_create"`. | | `data.action_metadata.results[].resource_ref` | object | No | When data.operation_type is `"review_bulk_update"`, `"exclusion_bulk_create"`. | | `data.action_metadata.results[].resource_ref.id` | string | Yes | When data.operation_type is `"review_bulk_update"`, `"exclusion_bulk_create"`. | | `data.action_metadata.results[].resource_ref.version` | string | Yes | When data.operation_type is `"review_bulk_update"`, `"exclusion_bulk_create"`. | | `data.action_metadata.results[].error` | object | No | When data.operation_type is `"review_bulk_update"`, `"exclusion_bulk_create"`. | | `data.action_metadata.results[].error.code` | string | Yes | When data.operation_type is `"review_bulk_update"`, `"exclusion_bulk_create"`. | | `data.action_metadata.results[].error.message` | string | Yes | When data.operation_type is `"review_bulk_update"`, `"exclusion_bulk_create"`. | | `data.action_metadata.results[].error.param` | string | No | When data.operation_type is `"review_bulk_update"`, `"exclusion_bulk_create"`. | | `data.operation_type` | `"scan"`, `"scan_continue"` | Yes | When data.operation_type is `"scan"`, `"scan_continue"`. | | `data.action_metadata.ai_child` | object | Yes | When data.operation_type is `"scan"`, `"scan_continue"`. | | `data.action_metadata.ai_child.state` | `"not_requested"`, `"pending_admission"`, `"admitted"`, `"skipped"`, `"failed"` | Yes | When data.operation_type is `"scan"`, `"scan_continue"`. | | `data.action_metadata.ai_child.reason_code` | string or null | Yes | When data.operation_type is `"scan"`, `"scan_continue"`. | | `data.action_metadata.ai_child.ai_run_id` | string | No | When data.operation_type is `"scan"`, `"scan_continue"`. | | `data.action_metadata.ai_child.ai_operation_id` | string | No | When data.operation_type is `"scan"`, `"scan_continue"`. | | `data.action_metadata.ai_child.operation_url` | string (uri) | No | When data.operation_type is `"scan"`, `"scan_continue"`. | Accepted work can continue after the request returns. Follow its returned status or operation until it finishes; accepting work does not mean every item succeeded. See [operation status](https://neondeerdata.com/docs/api/operations/). ### Errors | HTTP status | Meaning | | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | `400` | One of: credential_in_url, invalid_parameter, unknown_parameter, invalid_request. | | `401` | One of: missing_credential, invalid_credential, credential_expired, credential_revoked. | | `402` | One of: payment_overdue. | | `403` | The current permissions, plan or policy do not allow this request. | | `404` | One of: not_found. | | `409` | The request conflicts with current resource state, authorization or an earlier request. Read the error code and current resource before retrying. | | `410` | The requested resource or retained recovery data has expired. | | `412` | One of: version_conflict. | | `413` | One of: request_too_large. | | `422` | A field, filter or selection cannot be used for this request. | | `423` | One of: organization_reopening. | | `428` | One of: customer_agreement_required. | | `429` | One of: rate_limited. | | `503` | One of: service_unavailable. | See [errors and recovery](https://neondeerdata.com/docs/api/errors/) and [safe retries](https://neondeerdata.com/docs/api/requests/) before repeating a write. ## Prepare retry plan ```http POST /v1/deduplication/executions/{execution_id}/retry-plans ``` Prepares a new merge plan for chosen items of an execution that were confirmed not merged, including canceled items that were never sent. The whole request is refused if any chosen item merged, failed for good or is no longer safe to merge, or if its duplicate set still has merges that are unresolved. Nothing is sent: the new plan keeps the original size limits and runs only when it is executed itself; nothing from the earlier plan carries over. Requires `dedupe:propose`. The connection also needs access to the relevant tables, objects, or workflows. MCP action: `prepare_dedupe_merge_retry_plan`. Its argument names match the fields below; an HTTP header is passed using its argument name in MCP. ### Parameters | Name | Send in | Required | Type or allowed values | Notes | | ------------------ | ------------------------- | -------- | ---------------------- | ----- | | `execution_id` | path | Yes | string | | | `expected_version` | JSON body | Yes | string | | | `item_ids` | JSON body | Yes | array of string | | | `request_key` | Header: `Idempotency-Key` | Yes | string | | ### Response | HTTP status | Result | | ----------- | --------------------------------------------------------------------- | | `202` | The requested result. Asynchronous work returns an operation to poll. | Required fields are required within their containing object. Notes identify fields that apply only to a particular response alternative. | Response field | Type | Required in object | Notes | | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `data` | object | Yes | | | `data.id` | string | Yes | | | `data.object` | `"operation"` | Yes | | | `data.version` | string | Yes | | | `data.resource_id` | string | Yes | | | `data.resource_type` | string | Yes | | | `data.status` | `"pending"`, `"succeeded"`, `"failed"`, `"canceled"`, `"needs_attention"` | Yes | | | `data.terminal` | boolean | Yes | | | `data.created_at` | string (date-time) | Yes | | | `data.ended_at` | string (date-time) or null | Yes | | | `data.reason_code` | string or null | Yes | | | `data.replayed` | `true` | No | | | `data.operation_type` | `"scan_cancel"`, `"ai_assessment"`, `"ai_assessment_cancel"`, `"review_update"`, `"exclusion_create"`, `"exclusion_update"`, `"scheduled_batch_create"`, `"scheduled_batch_update"`, `"scheduled_batch_cancel"`, `"scheduled_run_cancel"`, `"scheduled_record_cancel"`, `"schedule_create"`, `"schedule_update"`, `"webhook_endpoint_create"`, `"webhook_endpoint_update"`, `"webhook_secret_rotate"`, `"endpoint_verification"`, `"webhook_replay"`, `"merge_rebuild"`, `"scheduled_batch_transfer"`, `"webhook_endpoint_transfer"` | Yes | When data.operation_type is `"scan_cancel"`, `"ai_assessment"`, `"ai_assessment_cancel"`, `"review_update"`, `"exclusion_create"`, `"exclusion_update"`, `"scheduled_batch_create"`, `"scheduled_batch_update"`, `"scheduled_batch_cancel"`, `"scheduled_run_cancel"`, `"scheduled_record_cancel"`, `"schedule_create"`, `"schedule_update"`, `"webhook_endpoint_create"`, `"webhook_endpoint_update"`, `"webhook_secret_rotate"`, `"endpoint_verification"`, `"webhook_replay"`, `"merge_rebuild"`, `"scheduled_batch_transfer"`, `"webhook_endpoint_transfer"`. | | `data.action_metadata` | object | Yes | | | `data.action_metadata.resource_version` | string | Yes | | | `data.action_metadata.allowed_actions` | array of string | Yes | | | `data.operation_type` | `"merge_execute"`, `"merge_cancel"` | Yes | When data.operation_type is `"merge_execute"`, `"merge_cancel"`. | | `data.action_metadata.execute_not_before` | string (date-time) | Yes | When data.operation_type is `"merge_execute"`, `"merge_cancel"`. | | `data.action_metadata.authorization_expires_at` | string (date-time) | Yes | When data.operation_type is `"merge_execute"`, `"merge_cancel"`. | | `data.operation_type` | `"plan_prepare"`, `"plan_revision_prepare"`, `"retry_plan_prepare"` | Yes | When data.operation_type is `"plan_prepare"`, `"plan_revision_prepare"`, `"retry_plan_prepare"`. | | `data.action_metadata.plan_revision` | string | Yes | When data.operation_type is `"plan_prepare"`, `"plan_revision_prepare"`, `"retry_plan_prepare"`. | | `data.action_metadata.effects_digest` | string or null | Yes | When data.operation_type is `"plan_prepare"`, `"plan_revision_prepare"`, `"retry_plan_prepare"`. | | `data.action_metadata.preview_digest` | string or null | Yes | When data.operation_type is `"plan_prepare"`, `"plan_revision_prepare"`, `"retry_plan_prepare"`. | | `data.action_metadata.recovery_coverage_digest` | string or null | Yes | When data.operation_type is `"plan_prepare"`, `"plan_revision_prepare"`, `"retry_plan_prepare"`. | | `data.action_metadata.authorization_requirement` | object | Yes | When data.operation_type is `"plan_prepare"`, `"plan_revision_prepare"`, `"retry_plan_prepare"`. | | `data.action_metadata.authorization_requirement.scope` | `"organization_baseline"` | Yes | When data.operation_type is `"plan_prepare"`, `"plan_revision_prepare"`, `"retry_plan_prepare"`. | | `data.action_metadata.authorization_requirement.mode` | `"api_key_allowed"`, `"not_allowed"` | Yes | When data.operation_type is `"plan_prepare"`, `"plan_revision_prepare"`, `"retry_plan_prepare"`. | | `data.action_metadata.authorization_requirement.policy_version` | string | Yes | When data.operation_type is `"plan_prepare"`, `"plan_revision_prepare"`, `"retry_plan_prepare"`. | | `data.action_metadata.authorization_requirement.grant_evaluation` | `"at_execution"` | Yes | When data.operation_type is `"plan_prepare"`, `"plan_revision_prepare"`, `"retry_plan_prepare"`. | | `data.action_metadata.authorization_requirement.reason_code` | string or null | Yes | When data.operation_type is `"plan_prepare"`, `"plan_revision_prepare"`, `"retry_plan_prepare"`. | | `data.action_metadata.authorization_state` | `"unauthorized"`, `"authorized"`, `"rejected"`, `"invalidated"`, `"expired"` | Yes | When data.operation_type is `"plan_prepare"`, `"plan_revision_prepare"`, `"retry_plan_prepare"`. | | `data.operation_type` | `"review_bulk_update"`, `"exclusion_bulk_create"` | Yes | When data.operation_type is `"review_bulk_update"`, `"exclusion_bulk_create"`. | | `data.action_metadata.results` | array of object | Yes | When data.operation_type is `"review_bulk_update"`, `"exclusion_bulk_create"`. | | `data.action_metadata.results[].index` | integer | Yes | When data.operation_type is `"review_bulk_update"`, `"exclusion_bulk_create"`. | | `data.action_metadata.results[].outcome` | `"succeeded"`, `"failed"` | Yes | When data.operation_type is `"review_bulk_update"`, `"exclusion_bulk_create"`. | | `data.action_metadata.results[].resource_ref` | object | No | When data.operation_type is `"review_bulk_update"`, `"exclusion_bulk_create"`. | | `data.action_metadata.results[].resource_ref.id` | string | Yes | When data.operation_type is `"review_bulk_update"`, `"exclusion_bulk_create"`. | | `data.action_metadata.results[].resource_ref.version` | string | Yes | When data.operation_type is `"review_bulk_update"`, `"exclusion_bulk_create"`. | | `data.action_metadata.results[].error` | object | No | When data.operation_type is `"review_bulk_update"`, `"exclusion_bulk_create"`. | | `data.action_metadata.results[].error.code` | string | Yes | When data.operation_type is `"review_bulk_update"`, `"exclusion_bulk_create"`. | | `data.action_metadata.results[].error.message` | string | Yes | When data.operation_type is `"review_bulk_update"`, `"exclusion_bulk_create"`. | | `data.action_metadata.results[].error.param` | string | No | When data.operation_type is `"review_bulk_update"`, `"exclusion_bulk_create"`. | | `data.operation_type` | `"scan"`, `"scan_continue"` | Yes | When data.operation_type is `"scan"`, `"scan_continue"`. | | `data.action_metadata.ai_child` | object | Yes | When data.operation_type is `"scan"`, `"scan_continue"`. | | `data.action_metadata.ai_child.state` | `"not_requested"`, `"pending_admission"`, `"admitted"`, `"skipped"`, `"failed"` | Yes | When data.operation_type is `"scan"`, `"scan_continue"`. | | `data.action_metadata.ai_child.reason_code` | string or null | Yes | When data.operation_type is `"scan"`, `"scan_continue"`. | | `data.action_metadata.ai_child.ai_run_id` | string | No | When data.operation_type is `"scan"`, `"scan_continue"`. | | `data.action_metadata.ai_child.ai_operation_id` | string | No | When data.operation_type is `"scan"`, `"scan_continue"`. | | `data.action_metadata.ai_child.operation_url` | string (uri) | No | When data.operation_type is `"scan"`, `"scan_continue"`. | Accepted work can continue after the request returns. Follow its returned status or operation until it finishes; accepting work does not mean every item succeeded. See [operation status](https://neondeerdata.com/docs/api/operations/). ### Errors | HTTP status | Meaning | | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | `400` | One of: credential_in_url, invalid_parameter, unknown_parameter, invalid_request. | | `401` | One of: missing_credential, invalid_credential, credential_expired, credential_revoked. | | `402` | One of: payment_overdue. | | `403` | The current permissions, plan or policy do not allow this request. | | `404` | One of: not_found. | | `409` | The request conflicts with current resource state, authorization or an earlier request. Read the error code and current resource before retrying. | | `410` | The requested resource or retained recovery data has expired. | | `412` | One of: version_conflict. | | `413` | One of: request_too_large. | | `422` | A field, filter or selection cannot be used for this request. | | `423` | One of: organization_reopening. | | `428` | One of: customer_agreement_required. | | `429` | One of: rate_limited. | | `503` | One of: service_unavailable. | See [errors and recovery](https://neondeerdata.com/docs/api/errors/) and [safe retries](https://neondeerdata.com/docs/api/requests/) before repeating a write. The [public OpenAPI document](https://neondeerdata.com/docs/api/meta/openapi/) lists generally available API families. Alpha operations may not appear in that document; their request and response fields are listed on this page. Use the [API Playground](https://neondeerdata.com/docs/api/testing/) to inspect a real response with your connection's access.