GET/image/sources/{image_source_id}

Get image source details

Retrieves the configuration and details for an image source. Use image_source_id to select the source; you can find the identifier in the dashboard or retrieve it from the source listing. The response includes source configuration and delivery settings.

1 parameter
image_source_idstringrequired

The image source identifier, available in the dashboard or from the source listing.

4 status codes
200Returns the image source object, including its identifier, namespace, type, origin configuration, cache settings, and other source details.
awsobjectoptional

This is a required field if source type is aws.

azureobjectoptional

This is a required field if source type is azure.

backblazeobjectoptional

This is a required field if source type is backblaze.

browser_cache_timeintegeroptional

Browser cache time in seconds

canonical_urlbooleanoptional
cdn_cache_timeintegeroptional

CDN cache time in seconds

cloudflareobjectoptional

This is a required field if source type is cloudflare.

cloudinaryobjectoptional

This is a required field if source type is cloudinary.

created_atstringoptional

Created timestamp in ISO 8601

default_paramsobjectoptional
dostorageobjectoptional

This is a required field if source type is dostorage.

fallback_originsarray<object>optional
gcsobjectoptional

This is a required field if source type is gcs.

hetznerobjectoptional
idstringrequired

Image source ID

imgixobjectoptional
is_activebooleanoptional
is_cloudfrontbooleanoptional
linodeobjectoptional

This is a required field if source type is linode.

namespacestringrequired

Source namespace (i.e. subdomain of gumlet.io)

proxyobjectoptional

This is a required field if source type is proxy.

request_headersarray<object>optional
response_headersarray<object>optional
secure_tokenstringoptional

This is the token that you can use to sign URLs.

secure_urlsbooleanoptional

Gives information if signed URLs are enabled.

subdomainstringoptional
temp_cnamearray<string>optional
typestringrequired
Allowed:dostorageawswasabihetznerbackblazewebfoldergcsazurecloudflareimgixcloudinaryproxy
updated_atstringoptional

Updated timestamp in ISO 8601

wasabiobjectoptional

This is a required field if source type is wasabi.

webfolderobjectoptional

This is a required field if source type is webfolder.

wordpressobjectoptional
401Returned when the API key or bearer token is missing or invalid.

One documented failure

  • invalid_api_key

    API key supplied with request is invalid

errorobjectrequired
403Returned when the account is unpaid or the authenticated user lacks the required role permissions.

One documented failure

  • unauthorized

    You don't have access to this feature. Please contact your organization owner.

errorobjectrequired
404Returned when the image source is not found.

One documented failure

  • source_not_found

    Could not find any image source with the specified source_id.

errorobjectrequired

Error handling

A 401 is returned when the API key or bearer token is missing or invalid, a 403 when the account is unpaid or lacks the required role permissions, and a 404 when the source is not found. The image_source_id path parameter must identify the image source you want to retrieve.