Skip to content

Get the org's blob-storage config

GET
/api/v1/integrations/storage
Code sample: cURL
curl -X GET 'https://dashboard.justcrawl.io/api/v1/integrations/storage' \
-H 'Authorization: Bearer $JUSTCRAWL_API_KEY'

Returns where job result blobs (HTML / JSON) are written for this org — either the JustCrawl-managed platform bucket (type: "platform", default for every org) or a customer-owned S3 bucket (type: "custom", set via PUT /storage). When custom, the response also includes the bucket name and whether S3 versioning is enabled on that bucket (drives the _v1/_v2/… suffix fallback when off).

documentExpiryDays is the org’s retention setting — null means indefinite (platform storage caps this internally). On custom buckets this drives the justcrawl-retention S3 Lifecycle rule installed by PUT /storage. Credentials are never returned; only metadata. Requires the org:manage permission.

Current storage config.

Media type application/json
object
type
string
Allowed values: platform custom
bucket
string
nullable
storageVersioningEnabled
boolean
nullable
documentExpiryDays
integer
nullable
Example
{
"type": "platform"
}

Missing or invalid authentication token

Media type application/json
object
error
string
Example
{
"error": "Missing or invalid authentication token"
}

Insufficient permissions for this operation

Media type application/json
object
error
string
Example
{
"error": "No organization. Complete onboarding first."
}

Unexpected server error. Logs and PostHog $exception capture

Media type application/json
object
error
string
Example
{
"error": "Something went wrong"
}