Skip to content
Blotout Docs

List shareable storage

GET
/teams/{teamId}/storage-links/{storageLinkId}/children/{domainId}/shareable
curl --request GET \
  --url https://qinto-api.blotout.io/teams/7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9/storage-links/a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d/children/3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15/shareable \
  --header 'Authorization: Bearer <token>'

Lists what a child could share from the parent: the identity graph as one item, and per installed app the storage it declares, each with whether the parent can satisfy it now and why not.

How it works

An item is available only when both sites are deployed and, for an app, both run the same fully deployed version and the parent has the object. The site’s own analytics datasets are never offered.

Required permissions

  • team:manage_storage_links:read on the team

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
teamId
required

Unique id (UUID) of the team that owns the addressed resources, as shown in the team settings on the Blotout platform.

string format: uuid

Example 

7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9

Unique id (UUID) of the team that owns the addressed resources, as shown in the team settings on the Blotout platform.

storageLinkId
required

Unique id (UUID) of the storage link configuration.

string format: uuid

Example 

a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d

Unique id (UUID) of the storage link configuration.

domainId
required

Unique id (UUID) of the child site.

string format: uuid

Example 

3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15

Unique id (UUID) of the child site.

Responses

Section titled “Responses”

200

Section titled “200”

The shareable storage.

Media typeapplication/json
object
identityGraph
required

Whether the identity graph can be shared as a whole.

object
available
required

Whether the parent can satisfy it now.

boolean
reason
required

Why it cannot be shared yet, or null when it can.

string | null
Allowed values: child_not_deployed child_not_converged parent_not_deployed parent_missing_app parent_not_converged version_mismatch parent_resource_missing
apps
required

The child’s installed apps, sorted by slug.

Array<object>
object
appId
required

Id of the app installed on the child.

string
appSlug
required

Its slug.

string
appName
required

Its name.

string
version
required

The version the child runs.

string
resources
required

The storage that app declares, with whether each item can be shared.

Array<object>
object
identifier
required

The resource identifier.

string
type
required

The kind of storage object.

string
Allowed values: kv d1 r2 analytics_engine vectorize durable_object
available
required

Whether the parent can satisfy it now.

boolean
reason
required

Why it cannot be shared yet, or null when it can.

string | null
Allowed values: child_not_deployed child_not_converged parent_not_deployed parent_missing_app parent_not_converged version_mismatch parent_resource_missing

Example 

{
  "identityGraph": {
    "available": true,
    "reason": "child_not_deployed"
  },
  "apps": [
    {
      "appId": "5a6b7c8d-9e0f-4a1b-8c2d-3e4f5a6b7c8d",
      "appSlug": "facebook-capi",
      "appName": "Facebook CAPI",
      "version": "1.4.0",
      "resources": [
        {
          "identifier": "cache",
          "type": "kv",
          "available": true,
          "reason": "child_not_deployed"
        }
      ]
    }
  ]
}

400

Section titled “400”

invalid_params — A path parameter failed validation (for example a malformed UUID); details pinpoints the offending parameter.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: invalid_params
details

Field-level validation errors: a tree keyed by input property, each node carrying an errors array of human-readable messages. Render it to help the caller correct the request.

object
key
additional properties

Example 

{
  "error": "invalid_params",
  "details": {
    "errors": [],
    "properties": {
      "teamId": {
        "errors": [
          "Invalid UUID"
        ]
      }
    }
  }
}

401

Section titled “401”

unauthenticated — The Authorization: Bearer token is missing, malformed, or no longer valid. Generate a team API token or obtain a new OAuth access token.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: unauthenticated

Example 

{
  "error": "unauthenticated"
}

403

Section titled “403”

forbidden — The bearer credential lacks the required permission or belongs to another team, or its user lacks the organization role a developer operation needs. Update its policies, use a credential bound to the addressed team, or ask an organization owner for the role; message states the reason when one is known.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: forbidden
message

Human-readable reason for this specific failure, intended for display — do not parse it programmatically.

string

Example 

{
  "error": "forbidden",
  "message": "The Cloudflare API token is invalid or expired."
}

404

Section titled “404”

not_found — The addressed resource does not exist within this team; check the id and retry.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: not_found

Example 

{
  "error": "not_found"
}

500

Section titled “500”

internal — Unexpected server error. Nothing is guaranteed to have been persisted; idempotent operations are safe to retry.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: internal

Example 

{
  "error": "internal"
}