StorageConnection

idstring<uuid>

workspace_idstring<uuid>

providerstring

Possible values: [s3, r2, s3_compatible]

endpointstring<uri>

The service address; derived from the region for s3 and from the account id for r2.

regionstringnullable

account_idstringnullable

jurisdictionstringnullable

Possible values: [default, eu]

bucketstring

prefixstring

force_path_styleboolean

key_templatestring

environmentsstring[]

Possible values: [live, test]

public_base_urlstringnullable

statusstring

active copies outputs; paused does not (see paused_reason).

Possible values: [active, paused]

paused_reasonstringnullable

failures: five permanent failures in a row (test the connection again to resume); plan: the plan no longer includes bring your own storage; workspace_deleted: the workspace was deleted and its credentials destroyed.

Possible values: [failures, workspace_deleted, plan]

access_key_hintstringnullable

The last four characters of the access key id.

Example: 7QX2

last_tested_atstring<date-time>nullable

last_error objectnullable

The provider's answer, reduced: its code, the HTTP status and the first line of its message.

codestring

Example: AccessDenied

http_statusintegernullable

Example: 403

messagestring

Example: Access Denied

created_atstring<date-time>

updated_atstring<date-time>

StorageConnection

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workspace_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "provider": "s3",
  "endpoint": "string",
  "region": "string",
  "account_id": "string",
  "jurisdiction": "default",
  "bucket": "string",
  "prefix": "string",
  "force_path_style": true,
  "key_template": "string",
  "environments": [
    "live"
  ],
  "public_base_url": "string",
  "status": "active",
  "paused_reason": "failures",
  "access_key_hint": "7QX2",
  "last_tested_at": "2024-07-29T15:51:28.071Z",
  "last_error": {
    "code": "AccessDenied",
    "http_status": 403,
    "message": "Access Denied"
  },
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z"
}