Skip to main content
PATCH
Update Location

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

location_id
string<uuid>
required
team_id
string<uuid>
required

Body

application/json

Schema for updating a location.

Most fields can be updated except location_type (would require creating a new location). If updating secret_id, the new secret must have the same type as the location's location_type.

Warning: Changing bucket_name, region, endpoint_url, or secret_id will affect all tasks using this location.

name
string | null
Required string length: 1 - 255
description
string | null
Maximum string length: 2000
bucket_name
string | null
Required string length: 1 - 255
region
string | null
Maximum string length: 100
endpoint_url
string | null
Maximum string length: 2048
secret_id
string<uuid> | null

Response

Successful Response

Schema for detailed location information.

id
string<uuid>
required
name
string
required
description
string | null
required
location_type
enum<string>
required

Cloud storage provider types.

Available options:
s3,
azure_blob,
gcs,
r2,
b2,
wasabi,
railway,
oracle_object_storage_s3,
s3_compatible,
tigris,
digitalocean_spaces,
hetzner,
rabata
bucket_name
string
required
region
string | null
required
endpoint_url
string | null
required
last_verified_at
string<date-time> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
created_by
string<uuid>
required
secret_id
string<uuid>
required
usage_stats
LocationUsageStats · object
required

Statistics about location usage in tasks.

last_verification
LocationVerificationSummary · object | null

Most recent verification attempt (success or failure) for health badge. last_verified_at only updates on success — this field reflects the actual most recent run regardless of outcome.

created_by_email
string | null

Email of user who created this location

updated_by
string<uuid> | null

User who last updated this location

updated_by_email
string | null

Email of user who last updated this location

secret_name
string | null

Name of the linked secret

tasks_as_source
LinkedTask · object[]

Tasks using this location as source

tasks_as_destination
LinkedTask · object[]

Tasks using this location as destination