Skip to main content

Bulk Cluster Options by lookupKey

POST 

/clusters/:lookupKey/:lookupValue/options/bulk

The bulk endpoints offer an efficient way of importing/updating large amounts of cluster options with just a single API call. The same lookup key is used for the options as for the cluster. When using the bulk id endpoint, the options are identified by Propeller option id. If an option with such id doesn't already exist, it will be created. If it does exist, the option will be updated.

Fields

NameRequired
namesno
descriptionsno
shortDescriptionsno
languageno
sourceIdno
sourceonly when sourceId is provided
isRequiredno

Directives

NameDescriptionFields
skipIfNotEmptyOn update, skip updating fields of an existing option that are not emptyarray of field names
e.g. names, descriptions, etc.
skipMoveOnUpdateOn update, skip moving an existing option in the parent cluster providedempty array
mergeTranslationsOnUpdateOn update, delete all translation for an option that are not provided in the payloadempty array
skipCreateDo not create new options, only update existingempty array

What are directives?

Request

Responses

Bulk Cluster Options by lookupKey - 200

Response Headers
    Alt-Svc
    Via
    alt-svc
    content-length
    date
    return-format
    x-request-id