Utilities¶
Use the endpoints described below to configure and manage encrypted credentials.
POST /api/v2/stringEncryptions/¶
DataRobot does not store your credentials when accessing external data stores. Instead you first encrypt your sensitive information with DataRobot and then, when accessing those data stores, supply the encrypted credentials. DataRobot will decrypt your credentials and use them to establish a connection to your data store.
Body parameter¶
{
"properties": {
"plainText": {
"description": "String to be encrypted. DataRobot will decrypt the string when needed to access data stores.",
"type": "string"
}
},
"required": [
"plainText"
],
"type": "object"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | StringEncryption | false | none |
Example responses¶
200 Response
{
"properties": {
"cipherText": {
"description": "Encrypted version of plainText input.",
"type": "string"
}
},
"required": [
"cipherText"
],
"type": "object"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Encryted string. | StringEncryptionResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
Schemas¶
StringEncryption
{
"properties": {
"plainText": {
"description": "String to be encrypted. DataRobot will decrypt the string when needed to access data stores.",
"type": "string"
}
},
"required": [
"plainText"
],
"type": "object"
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
plainText | string | true | String to be encrypted. DataRobot will decrypt the string when needed to access data stores. |
StringEncryptionResponse
{
"properties": {
"cipherText": {
"description": "Encrypted version of plainText input.",
"type": "string"
}
},
"required": [
"cipherText"
],
"type": "object"
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
cipherText | string | true | Encrypted version of plainText input. |