place.stream.server.upsertStorage

did:web:stream.place

Documentation

Create or update S3 storage configuration for backups.

main procedure

Create or update S3 storage configuration for backups.

Input

Encodingapplication/json
isActive boolean Optional

Whether backup storage is currently active.

url string Optional

S3 storage URL in format: s3+https://ACCESS_KEY:SECRET_KEY@endpoint/bucket

Output

Encodingapplication/json

Errors

InvalidUrl The provided S3 URL is invalid or malformed.
ConnectionFailed Could not connect to the S3 endpoint with the provided credentials.
MaskedCredentialsModified Cannot modify URL while keeping masked credentials. Provide full credentials or omit URL to keep existing configuration.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema
{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string",
          "description": "S3 storage URL in format: s3+https://ACCESS_KEY:SECRET_KEY@endpoint/bucket"
        },
        "isActive": {
          "type": "boolean",
          "description": "Whether backup storage is currently active."
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "InvalidUrl",
      "description": "The provided S3 URL is invalid or malformed."
    },
    {
      "name": "ConnectionFailed",
      "description": "Could not connect to the S3 endpoint with the provided credentials."
    },
    {
      "name": "MaskedCredentialsModified",
      "description": "Cannot modify URL while keeping masked credentials. Provide full credentials or omit URL to keep existing configuration."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "storage"
      ],
      "properties": {
        "storage": {
          "ref": "place.stream.server.defs#storage",
          "type": "ref"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": null,
  "description": "Create or update S3 storage configuration for backups."
}

Lexicon Garden

@