Skip to content
Blotout Docs

Create a storage link

POST
/teams/{teamId}/storage-links
curl --request POST \
  --url https://qinto-api.blotout.io/teams/7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9/storage-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "EU markets", "parentDomainId": "3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15" }'

Creates a storage link configuration around one parent site. Add child sites afterwards and choose per child what they share.

How it works

The parent must be deployed and in no other configuration, or the call fails with not_eligible; a name the team already uses fails with name_taken. Nothing is deployed by this call.

Required permissions

  • team:manage_storage_links:write 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.

Request Bodyrequired

Section titled “Request Bodyrequired”

The name and the parent site.

Media typeapplication/json
object
name
required

Name of the configuration, unique within the team, up to 100 characters.

string
>= 1 characters <= 100 characters

Example 

EU markets
parentDomainId
required

The site whose storage the children will share.

string format: uuid

Example 

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

Responses

Section titled “Responses”

201

Section titled “201”

The configuration was created.

Media typeapplication/json
object
storageLinkId
required

Id of the new configuration.

string

Example 

{
  "storageLinkId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"
}

400

Section titled “400”

invalid_params — A path parameter failed validation (for example a malformed UUID); details pinpoints the offending parameter. invalid_body — The JSON body is unparseable or failed schema validation; details pinpoints the offending fields when the body could be parsed.

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 invalid_body
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"
}

409

Section titled “409”

not_eligible — The site cannot join this configuration: it is not deployed, is on another host or jurisdiction than the parent, or still binds storage from an earlier link. message states which. name_taken — The team already has a storage link configuration with this name; choose another. already_linked — The site already belongs to a storage link configuration, as parent or child; a site is in at most one. Remove it there first.

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_eligible name_taken already_linked

Example 

{
  "error": "not_eligible"
}

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"
}