Skip to content

List eligible sites

GET
/teams/{teamId}/storage-links/{storageLinkId}/eligible-sites
curl --request GET \
--url https://qinto-api.blotout.io/teams/7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9/storage-links/a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d/eligible-sites \
--header 'Authorization: Bearer <token>'

Lists the sites that can be added to the configuration as children: on the parent’s host and jurisdiction, deployed, and in no configuration. The list is empty until the parent is deployed.

Required permissions

  • team:manage_storage_links:read on the team
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.

The eligible sites.

Media typeapplication/json
object
sites
required

Sites that can be added as children, sorted by hostname.

Array<object>
object
domainId
required

Id of the site.

string
domain
required

Its hostname.

string

Example

{
"sites": [
{
"domainId": "3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15",
"domain": "de.example.com"
}
]
}

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

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

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

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

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