Skip to main content

Illumio REST APIs 25.4

Rule-Based Label Mapping

New APIs for managing the new feature, Rule-based label mapping, are the following:

Label Mapping API Methods

Functionality

HTTP

URI

Returns the collection of label mapping rules.

GET

/orgs/:xorg_id/label_mapping_rules

Creates a new label-mapping rule.

POST

/orgs/:xorg_id/label_mapping_rules

Deletes multiple label mapping rules

PUT

/orgs/{org_id}/label_mapping_rules/delete

Gets the instance of a single label-mapping rule.

GET

/orgs/:xorg_id/label_mapping_rules/:label_mapping_rule_id

Updates the instance of a single rule.

PUT

/orgs/:xorg_id/label_mapping_rules/:label_mapping_rule_id

Deletes the specified label-mapping rule.

DELETE

/orgs/:xorg_id/label_mapping_rules/:label_mapping_rule_id

Reorders label-mapping rules.

PUT

/orgs/{org_id}/label_mapping_rules/{label_mapping_rule_id}/reorder

This asynchronous API runs a set of label-mapping rules on a set of workloads.

POST

/orgs/:xorg_id/label_mapping_rules/run

Gets the status of the async job to run the rules.

GET

/orgs/:xorg_id/label_mapping_rules/run/:job_uuid

Downloads the results of the run rules job.

GET

/orgs/:xorg_id/label_mapping_rules/run/:job_uuid/download

Assign labels from the results of the label-mapping rules, and run the job.

PUT

/:xorg_id/label_mapping_rules/run/:job_uuid/assign_labels

Bulk label update

PUT

[api_version][label_href]label_mapping_rules_update

Bulk label update

If an organization has 500 rules defined, the UI must make up to 500 individual calls in an enable/disable rules operation.

This issue is resolved using the "bulk update" endpoint, which was chosen instead of a "bulk enable/disable" API because it provides additional flexibility to support future use cases.

label_mapping_rule_label_assignments.schema.json

The property label_assignment was deleted and replaced with a reference to label_mapping_rule_label_assignments.schema.json for the following APIs:

  • label_mapping_rules_post

  • label_mapping_rules_get

  • label_mapping_rules_put