url

url identifies remote content for an Add* command instead of supplying an input blob. It applies to Add* commands that accept blobs, except AddDescriptor. The content remains in remote storage.

Supported locations are S3 (s3://<bucket>/<path>), Google Cloud Storage (gs://<bucket>/<path>), and authorized HTTPS origins. CreateCredential registers the credential for the bucket or origin; no other credentials are used. URLs into ApertureDB’s own storage bucket are refused. HTTPS origins have additional authentication and URL restrictions.

Register credentials first

Register the origin and wait for success before submitting a query that uses its URLs. Creating or changing a credential in the same query does not change the key used for that query’s media reads, even if the credential command comes first. A request already underway may finish with the previous key after a change. See Remote credentials for rotation, removal, and batch-page behavior.

Examples

The following command registers an image in an S3 bucket. It takes no input blob with the JSON query.

[{
    "AddImage": {
        "properties": {
            "type": "scan",
            "part": "brain"
        },
        "url": "s3://aperturedb-s3-api-testing-0/brain.png"
    }
}]

Response:

[{
    "AddImage": {
        "status": 0
    }
}]