SymetryML Documentation
Data sources

Edit data source configuration

Replaces a data source's configuration.

PUT
/{user}/dss/{dsName}

Replaces a data source's configuration.

Authorization

SymetryMLAuth
AuthorizationBearer <token>

HMAC-SHA256 signature-based authentication: requests are signed with your secret key and sent with the Customer-ID, Sym-date, Authorization, Content-MD5 and sym-version headers. See SymetryML REST API Security for the signature algorithm and a complete example.

In: header

Path Parameters

user*string

User/Customer identifier

dsName*string

Data source name

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

body*string

Encrypted DSInfo. The dsName path segment is not actually used by the server — the data source to edit is determined entirely by the name field inside this encrypted body, which must already exist and match an existing data source's name and type (the type cannot be changed).

This is a full replace, not a merge/patch: any info property present on the existing data source but omitted from this body is removed.

Decrypted equivalent of the example body:

{  "name":"DSEditTest-ds",  "type":"s3",  "info":{      "s3accessKey":"XXXXXXXXXX",      "s3secretKey":"XXXXXXXXXX",      "s3bucket":"rtlm-dev",      "path":"Iris_rtlm.csv",      "read.line.offset":10,      "read.line.total":11  }}

Response Body

application/json

application/json

application/json

curl -X PUT "https://example.com/c1/dss/nbra_ds_sftp_iris" \  -H "Content-Type: application/json" \  -d '/oZVLWVA2VczyB572ZSMl3bhwMGlCN1Eh4VYYAsDQQqyI8vCCexofRRfTawYUFGAEsncCKIiWJ/OXilhTpQQBDknw95iqMbsHtM7mvguzkJK8M9HKmzDvuTg1cGQEsdgcTRDOP4Zm8OxUOeJJNB6AT6oR2muP43D6iKmQpguJuQOgfxGJPdUxH4EI1=='
{  "statusCode": 200,  "statusString": "DS updated with name [s3Ds] for customer [c1]",  "values": {}}

{  "statusCode": 400,  "statusString": "Invalid DS offset: noninteger; it must be an integer",  "values": {}}

{  "statusCode": 404,  "statusString": "Customer [c1] has no DS with name [myDs]",  "values": {}}