Update general settings configuration except Auth

patch {protocol}://{base-url}/integration/v2/datasource/{datasource_id}/configuration/

Fully or partially update the existing configuration settings for an OCF data source, not including certain authentication settings. Use the GET method first to get the existing configuration settings and use the information to form the request body for the PATCH method.

Responses

Response body

array of objects

object

name

string

required

The name of the parameter as it appears in the UI on the data source's General Settings page.

key

string

required

A unique identifier for the parameter. Use this key in PATCH requests to update the parameter's value.

usage

string

required

A description of the parameter's purpose. For example, it may be a URI to connect to a data source or it may be a parameter for uploading a certificate.

parameter_type

string

required

Data type for this parameter. Valid types are: ARRAY_OF_TEXT - Comma seperated values of text. BOOLEAN - True or False. DICTIONARY - When getting this parameter type, value will be a JSON dictionary. In Python you can use json.stringify(dict) to obtain the dictionary. When patching this parameter type, the value should be a properly escaped JSON dictionary, for example: '{"k1": "v1", "k2": "v2"}'. ENCRYPTED_BINARY - When getting this parameter type, value will always be __secure__. When patching this parameter type, a file will need to be attached to the call's form data. After being uploaded, the file will be stored as encrypted binary. ENCRYPTED_TEXT - Sensitive text such as passwords. When getting this parameter type, value will always be __secure__. When patching this parameter type, you can send any text as the value, and it will be stored in an encrypted form. INTEGER - A valid integer value. RADIO - A valid option from the list specified in options. SELECT - A valid option from the list specified in options. TEXT - A short text value, such as username or email. TEXT_AREA - A large text value, such as a SQL query.

ARRAY_OF_TEXT BOOLEAN DICTIONARY ENCRYPTED_BINARY ENCRYPTED_TEXT INTEGER RADIO SELECT TEXT TEXT_AREA

is_vault_param

boolean

required

Denotes whether the parameter value should be fetched from key/secret manager or from Alation. If true it fetches value from key/secret manager.

vault_config_name

string

required

A valid key/secret manager config that exists in the respective vault such as AWS secrets manager or Azure key-vault storage.

vault_key

string

required

A valid ARN for the AWS vault resource to fetch the values from

value

required

A value for this parameter that is stored in Alation. This will be __secure__ if its parameter_type is ENCRYPTED_BINARY or ENCRYPTED_TEXT.

filename

string

File name for an uploaded file, if the parameter_type is ENCRYPTED_BINARY.

options

array of strings

options

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://alation_domain/integration/v2/datasource/datasource_id/configuration/ \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Choose an example:

application/json

200Updated datasource configuration successfully

400Malformed Request

401Unauthorized bad/missing token

403Forbidden User cannot edit this resource

404The specified resource was not found

500Internal Server Error