Endpoint

/v1/object-portal/notify

POST

Inject a bridge notification for the given bucket and key into the notification routing pipeline. A bucket no bridge serves is counted undeliverable and answers HTTP 200.

Parameters

This resource has no parameters.

Request

Schema

{
  "description": "api_bridge_notify_request",
  "type": "object",
  "properties": {
    "bucket_uri": {
      "description": "Bucket URI as it appears in the bridge's configuration",
      "type": "string"
    },
    "key": {
      "description": "Object key within the bucket",
      "type": "string"
    },
    "etag": {
      "description": "Etag of the object as reported by the cloud event payload, when present",
      "type": "string"
    },
    "version_id": {
      "description": "Version id of the object as reported by the cloud event payload, when present",
      "type": "string"
    },
    "sequencer": {
      "description": "Provider ordering token for events on this key. An event whose sequencer orders at or below the one stored on the file drops as stale.",
      "type": "string"
    },
    "event_type": {
      "type": "string",
      "enum": [
        "CREATED",
        "DELETED",
        "STORAGE_CLASS_CHANGED",
        "ACCESS_TIER_CHANGED",
        "RESTORE_INITIATED",
        "RESTORE_COMPLETED",
        "RESTORE_EXPIRED",
        "TAGS_CHANGED"
      ],
      "description": "Kind of change the cloud event reports. Treated as CREATED when omitted.:\n * `ACCESS_TIER_CHANGED` - BRIDGE_EVENT_KIND_ACCESS_TIER_CHANGED,\n * `CREATED` - BRIDGE_EVENT_KIND_CREATED,\n * `DELETED` - BRIDGE_EVENT_KIND_DELETED,\n * `RESTORE_COMPLETED` - BRIDGE_EVENT_KIND_RESTORE_COMPLETED,\n * `RESTORE_EXPIRED` - BRIDGE_EVENT_KIND_RESTORE_EXPIRED,\n * `RESTORE_INITIATED` - BRIDGE_EVENT_KIND_RESTORE_INITIATED,\n * `STORAGE_CLASS_CHANGED` - BRIDGE_EVENT_KIND_STORAGE_CLASS_CHANGED,\n * `TAGS_CHANGED` - BRIDGE_EVENT_KIND_TAGS_CHANGED"
    },
    "destination_storage_class": {
      "description": "Destination storage class of a STORAGE_CLASS_CHANGED event, in AWS's vocabulary (e.g. GLACIER). Absent or unrecognized means unknown.",
      "type": "string"
    },
    "destination_access_tier": {
      "description": "Destination access tier of an ACCESS_TIER_CHANGED event (ARCHIVE_ACCESS or DEEP_ARCHIVE_ACCESS). Absent or unrecognized means not archived.",
      "type": "string"
    },
    "restore_expiry_time": {
      "description": "RFC 3339 expiry of the restored copy reported by a RESTORE_COMPLETED event. Absent or undecodable leaves the restore without an expiry.",
      "type": "string"
    }
  }
}

Response

Codes

Code Description
200 Return value on success