🚧

Your Control Plane URL will vary

The Control Plane URL, denoted as YOUR_CP_URL for this API reference document is https://facetsdemo.console.facets.cloud.
Replace that with the Control Plane URL unique to your account.

API Endpoint

This API processes a PUT request to override the current configuration for CI Rules.

https://<CP_URL>/cc-ui/v1/artifact-routing-rule \

Body parameters

artifactRoutingRuleRequest is an object that will take key:value pairs of type String in code.

{
  "artifactRoutingRuleRequest": {
    "criteria": [
      {
        "metadataKey": "string",
        "operator": "EQUALS",
        "priority": 0,
        "routeTo": "string",
        "value": "string"
      }
    ],
    "id": "string",
    "isDefault": true,
    "registrationType": "ENVIRONMENT",
    "ruleName": "string",
    "stackName": "string"
  }
}

Authenticate your API request

To learn more about how to generate a basic authentication token for use with Facets API requests, check Authentication Setup.

📘

Facets API uses Basic Authentication.

Generate a Sample Request ➡️

Fill in the mandatory parameter below using the updated response body to generate a sample request. To know more about updating the body parameter, refer to the Update Response Body section.

Language
Authorization
Basic
base64
:
Click Try It! to start a request and see the response here!