Updating the ETL configuration by using API

Use the Modify configuration APIs to update selected or all the properties from the ETL configuration.

Before you begin

Ensure that the following requirements are met:

The appropriate read or write activity is assigned to your user role to access the API. The user account must have the following permissions (through user roles):
- READ: capacity_optimization.admin.etls_read or capacity_optimization.admin.admin_section_read
- WRITE: capacity_optimization.custom_etl.edit or capacity_optimization.admin.admin_section_edit

For information about the user roles and permissions, see Default-user-roles-and-permissions.

Valid user credentials or a bearer token is available for authentication. For more information, see Access-and-authentication-for-the-REST-API.

Patch an ETL

post/opt/api/v1/backend/etls/<etl-id>/configuration/update

Updates the specified set of details for the given ETL ID.

Request URL

https://<host_name>/opt/api/v1/backend/etls/<etl-id>/configuration/update

Example request URL

https://hostname.bmc.com/opt/api/v1/backend/etls/468/configuration/update

Request Header

Content-Type: application/json
Authorization: Bearer <jwttoken>

Request body

{
"encryption_passphrase": "<password>",
"properties": {
   "general.log.level": "5",
   "property.to.add": "to-add"
},
"properties_to_delete": {
   "property.to.delete": "to-delete"
}
}

Bulk patch a set of ETLs identified by a condition

POST/opt/api/v1/backend/etls/configuration/update

Updates a set of ETLs in bulk that associated by a specific condition.

Request URL

https://<host_name>/opt/api/v1/backend/etls/configuration/update

Example request URL

https://hostname.bmc.com/opt/api/v1/backend/etls/configuration/update

Request Header

Content-Type: application/json
Authorization: Bearer <jwttoken>

The etl_instance_filter section in the request body is based on the syntax of API.

Request body

{
"etl_instance_filter": {
   "entity_catalog_id": "6",
   "properties_filter_operator": "OR",
   "properties_filter": {
     "general.log.level": "10"
   }
},
"properties": {
   "general.log.level": "1"
}
}

Patch an ETL (Update password)

POST/opt/api/v1/backend/etls/<etl-id>/configuration/update

Example request URL

https://hostname.bmc.com/opt/api/v1/backend/etls/415/configuration/update

Request Header

Content-Type: application/json
Authorization: Bearer <jwttoken>

Request body

{
"encryption_passphrase": "<password>",
"properties": {
"general.log.level": "1",
"extract.access.key.secret.password": "Ywzfj0c5qGj+bHlzR9mD+aIqv2QywR4LZ72lPjHU"
}
}

Patch a service ETL

POST/opt/api/v1/backend/etls/<etl-id>/configuration/update

Example request URL

https://hostname.bmc.com/opt/api/v1/backend/etls/276/configuration/update

Request Header

Content-Type: application/json
Authorization: Bearer <jwttoken>

Request body

{
"properties": {
"general.log.level": "1",
"test.test": "rraff"
}
}

Patch an ETL (Delete properties)

POST/opt/api/v1/backend/etls/<etl-id>/configuration/update

Example request URL

https://hostname.bmc.com/opt/api/v1/backend/etls/458/configuration/update

Request Header

Content-Type: application/json
Authorization: Bearer <jwttoken>

Request body

{
"encryption_passphrase": "<password>",
"properties_to_delete": {
"test.test": "rraff"
}
}

Update all the properties of the ETL - PUT

put/opt/api/v1/backend/etls/<etl-id>/configuration

Updates all the details of the specified ETL ID.

Request URL

https://<host_name>/opt/api/v1/backend/etls/<etl-id>/configuration

Example request URL

https://hostname.bmc.com/opt/api/v1/backend/etls/451/configuration

Request Header

Content-Type: application/json
Authorization: Bearer <jwttoken>

Request body

{
"encryption_passphrase": "<password>",
"scheduling": {
   "scheduled": false,
   "scheduler_id": 0,
   "period_sec": 86400,
   "start_date": "2022-04-27T00:00:00Z"
},
"etl": {
   "instance_name": "AWS TEST CREATION 2 - patched"
},
"task_group_id": 5,
"properties": {
   "extract.access.key.id": "AKIAJNKJWEC2TDWDG56A",
   "extract.access.key.secret.password.encrypted": "qTOg8Ho9jaN6lxvZZkdjZgBYgPyqbZUmfWRyRYQmu2pJt3OA6bUp+NVoezayXYpol2DXabM2udHXDYHohsl1QyxS/mg=",
   "extract.aws.account.options": "SINGLE",
   "extract.aws.us.gov.cloud": "false",
   "extract.database.iscustom": "true",
   "extract.default.region": "us-east-1",
   "extract.module": "com.bmc.bco.aws.extractor.DMAWSExtractorE",
   "extract.prop.bs.tag.key": "Service",
   "general.dataset.idlist": "1;59;103;7;118;30",
   "general.log.level": "10",
   "general.module.selection": "DATASOURCE",
   "general.options.onemptydataset": "WARN",
   "general.simulation": "false",
   "loader.lookup.remove.domain": "false",
   "loader.sysnm.leave.domain": "false",
   "mask.ignorevalidation": "false"
},
"object_relationships": {
   "domain_mode": "EXISTING",
   "domain_id": "129112"
},
"entity_catalog": {
   "sharing_status": "SHARED",
   "entity_catalog_id": 2
},
"metric_profile": {
   "level": 3,
   "metric_profile_id": 0
}
}

Response

HTTP code	Message	Description
204	OK	Request succeeded
400		ETL not found
500		Error

Updating the ETL configuration by using API

Before you begin

Patch an ETL

Bulk patch a set of ETLs identified by a condition

Patch an ETL (Update password)

Patch a service ETL

Patch an ETL (Delete properties)

Update all the properties of the ETL - PUT

Response

On this page