---
title: "POST /v1/{+parent}/canaryevaluations"
method: POST
path: "/v1/{+parent}/canaryevaluations"
tags: ["organizations"]
---

# POST /v1/{+parent}/canaryevaluations

`POST /v1/{+parent}/canaryevaluations`

Creates a new canary evaluation for an organization.

## Path parameters

- `parent` string, required

## Request body

- GoogleCloudApigeeV1CanaryEvaluation — CanaryEvaluation represents the canary analysis between two versions of the runtime that is serving requests.
  - `name` string — Output only. Name of the canary evalution.
  - `verdict` 'VERDICT_UNSPECIFIED' | 'NONE' | 'FAIL' | 'PASS' — Output only. The resulting verdict of the canary evaluations: NONE, PASS, or FAIL.
  - `control` string — Required. The stable version that is serving requests.
  - `state` 'STATE_UNSPECIFIED' | 'RUNNING' | 'SUCCEEDED' — Output only. The current state of the canary evaluation.
  - `metricLabels` GoogleCloudApigeeV1CanaryEvaluationMetricLabels — Labels that can be used to filter Apigee metrics.
    - `instance_id` string — Required. The instance ID associated with the metrics. In Apigee Hybrid, the value is configured during installation.
    - `location` string — Required. The location associated with the metrics.
    - `env` string — The environment ID associated with the metrics.
  - `startTime` string, google-datetime — Required. Start time for the canary evaluation's analysis.
  - `createTime` string, google-datetime — Output only. Create time of the canary evaluation.
  - `endTime` string, google-datetime — Required. End time for the evaluation's analysis.
  - `treatment` string — Required. The newer version that is serving requests.

## Response `200`

Successful response

---

[API](https://skmtc.net/google/apis/apigee.md) · [All operations](https://skmtc.net/google/apis/apigee/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/apigee/versions/6e272fa448a7/schema)