Skip to main content
PUT
/
v1
/
admin
/
hosted-sources
/
{source_id}
Update a hosted source
curl --request PUT \
  --url https://api.withsplendor.com/v1/admin/hosted-sources/{source_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-splendor-tenant-id: <x-splendor-tenant-id>' \
  --data '
{
  "dataset_id": "<string>",
  "format": "<string>",
  "name": "<string>",
  "source_key": "<string>",
  "source_type": "<string>",
  "connector_id": 123,
  "enabled": true,
  "parse_config": {},
  "retention_days": 2,
  "search_config": {
    "text_fields": [
      {
        "field": "<string>",
        "boost": 1,
        "natural_language": true
      }
    ]
  },
  "semantic_config": {
    "document_embeddings": {
      "fields": [
        {
          "field": "<string>",
          "max_chars": 4000
        }
      ]
    },
    "vocabulary": {
      "fields": [
        {
          "field": "<string>"
        }
      ]
    }
  },
  "transform_config": {}
}
'
{
  "bucket": "acme-logs",
  "connector_id": null,
  "created_at": "2026-01-15T09:30:00Z",
  "dataset_id": "app-logs",
  "enabled": true,
  "external_id_configured": false,
  "format": "jsonl",
  "iam_role_arn": "arn:aws:iam::123456789012:role/acme-splendor",
  "ingest_token_configured": true,
  "ingest_token_created_at": "2026-01-15T09:30:00Z",
  "ingest_token_last_used_at": "2026-01-15T09:30:00Z",
  "ingest_token_revoked_at": null,
  "intake_role_arn": null,
  "name": "Application logs",
  "parse_config": {},
  "prefix": "",
  "retention_days": null,
  "search_config": {
    "text_fields": []
  },
  "semantic_config": {
    "document_embeddings": {
      "fields": []
    },
    "vocabulary": {
      "fields": []
    }
  },
  "source_id": 12,
  "source_key": "app-logs",
  "source_type": "hosted",
  "tenant_id": "acme",
  "transform_config": {},
  "updated_at": "2026-01-15T09:30:00Z"
}

Authorizations

Authorization
string
header
required

API token issued from the Splendor console.

Headers

x-splendor-tenant-id
string
required

Selects the tenant (workspace) the request acts within.

Path Parameters

source_id
integer
required

Body

application/json
dataset_id
string
required
Required string length: 1 - 128
format
string
required
Required string length: 1 - 64
name
string
required
Required string length: 1 - 255
source_key
string
required
Required string length: 1 - 128
source_type
string
required
Required string length: 1 - 128
connector_id
integer | null
enabled
boolean
default:true
parse_config
Parse Config · object
retention_days
integer | null
Required range: x >= 1
search_config
SearchConfig · object
semantic_config
SemanticConfig · object
transform_config
Transform Config · object

Response

Successful Response

bucket
string
required
connector_id
integer | null
required
created_at
string<date-time>
required
dataset_id
string
required
enabled
boolean
required
external_id_configured
boolean
required
format
string
required
iam_role_arn
string
required
ingest_token_configured
boolean
required
ingest_token_created_at
string<date-time> | null
required
ingest_token_last_used_at
string<date-time> | null
required
ingest_token_revoked_at
string<date-time> | null
required
intake_role_arn
string | null
required
name
string
required
parse_config
Parse Config · object
required
prefix
string
required
retention_days
integer | null
required
search_config
SearchConfig · object
required
semantic_config
SemanticConfig · object
required
source_id
integer
required
source_key
string
required
source_type
string
required
tenant_id
string
required
transform_config
Transform Config · object
required
updated_at
string<date-time>
required