Sign in
TrafficPolicy

Promote the canary backend to stable (canary only)

Changed on
post/api/v1/trafficpolicies/{name}/promote

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/trafficpolicies/{name}/promote
  • Auth: none declared

Path parameters

namestring required

Response

Promoted.

accessUrlstring

Resolved external URL clients call (read-only).

canaryPercentinteger

For canary mode, percent of traffic on the canary backend (stable = 100−p).

createdAtstring date-time required

Time the policy was created.

descriptionstring

Free-text policy description.

displayNamestring

Human-readable policy label.

idstring uuid required

Stable traffic policy identifier.

messagestring

Human-readable status detail for the current phase.

mode'weighted' | 'canary' required
namestring required

Traffic policy name (unique within the tenant).

namespacestring required

Platform tenant namespace the policy belongs to.

ownerstring required

Username of the policy owner.

ownerIdstring uuid

User ID of the policy owner.

phase'Creating' | 'Pending' | 'Ready' | 'Degraded' | 'Failed' | 'Deleting' | 'Deleted'
tenantDisplayNamestring

Human-readable tenant name.

tenantNamestring required

Tenant identifier owning the policy.

updatedAtstring date-time required

Time the policy was last updated.

Example response

{
  "accessUrl": "https://infer.axisml.io/services/team-vision/resnet-serving/",
  "backends": [
    {
      "actualPct": 90,
      "ready": true,
      "role": "stable",
      "serviceName": "resnet-serving-v1",
      "weight": 90
    },
    {
      "actualPct": 10,
      "ready": true,
      "role": "canary",
      "serviceName": "resnet-serving-v2",
      "weight": 10
    }
  ],
  "canaryPercent": 10,
  "createdAt": "2026-06-20T08:00:00Z",
  "description": "Canary traffic split for the ResNet-50 online inference service.",
  "displayName": "ResNet inference traffic",
  "endpoint": {
    "hostname": "infer.axisml.io",
    "path": "/services/team-vision/resnet-serving/"
  },
  "id": "d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90",
  "message": "Routing 90/10 between stable and canary.",
  "mode": "canary",
  "name": "resnet-serving",
  "namespace": "team-vision",
  "owner": "li.wei",
  "ownerId": "3a2b1c0d-4e5f-6789-abcd-ef0123456789",
  "phase": "Ready",
  "tenantDisplayName": "Vision Team",
  "tenantName": "team-vision",
  "updatedAt": "2026-06-28T09:30:00Z"
}

Changes

  • d51e2e0e6970Revision changes
    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      removed the Creating enum value from the response property for the response status

    • info

      removed the Degraded enum value from the response property for the response status

    • info

      removed the Deleted enum value from the response property for the response status

    • info

      removed the Deleting enum value from the response property for the response status

    • info

      removed the Failed enum value from the response property for the response status

    • info

      removed the Pending enum value from the response property for the response status

    • info

      removed the Ready enum value from the response property for the response status

    • info

      removed the canary enum value from the // response property for the response status

    • info

      removed the canary enum value from the response property for the response status

    • info

      removed the member enum value from the // response property for the response status

    • info

      removed the stable enum value from the // response property for the response status

    • info

      removed the weighted enum value from the response property for the response status