Continuous Delivery Foundation

Continuous Delivery Foundation V 2 Canary Controller API

The v-2-canary-controller API from Continuous Delivery Foundation — 9 operation(s) for v-2-canary-controller.

Documentation GitHub OpenAPI

Operations 9

POST /v2/canaries/canary Start a canary execution with the supplied canary config #

POST /v2/canaries/canary/{canaryConfigId} Start a canary execution #

GET /v2/canaries/canary/{canaryConfigId}/{canaryExecutionId} (DEPRECATED) Retrieve a canary result #

GET /v2/canaries/canary/{canaryExecutionId} Retrieve a canary result #

GET /v2/canaries/credentials Retrieve a list of configured Kayenta accounts #

GET /v2/canaries/judges Retrieve a list of all configured canary judges #

GET /v2/canaries/metadata/metricsService Retrieve a list of descriptors for use in populating the canary config ui #

GET /v2/canaries/metricSetPairList/{metricSetPairListId} Retrieve a metric set pair list #

GET /v2/canaries/{application}/executions Retrieve a list of an application's canary results #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/continuous-delivery-foundation-v-2-canary-controller-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  contact:
    name: ''
  description: ''
  title: Spinnaker V 2 Canary Controller API
servers:
- description: Generated server url
  url: http://localhost
tags:
- name: v-2-canary-controller
paths:
  /v2/canaries/canary:
    post:
      operationId: initiateCanaryWithConfig
      parameters:
      - in: query
        name: application
        required: false
        schema:
          type: string
      - in: query
        name: parentPipelineExecutionId
        required: false
        schema:
          type: string
      - in: query
        name: metricsAccountName
        required: false
        schema:
          type: string
      - in: query
        name: storageAccountName
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: {}
              type: object
        required: true
      responses:
        '200':
          content:
            '*/*':
              schema:
                additionalProperties: {}
                type: object
          description: OK
      summary: Start a canary execution with the supplied canary config
      tags:
      - v-2-canary-controller
  /v2/canaries/canary/{canaryConfigId}:
    post:
      operationId: initiateCanary
      parameters:
      - in: path
        name: canaryConfigId
        required: true
        schema:
          type: string
      - in: query
        name: application
        required: false
        schema:
          type: string
      - in: query
        name: parentPipelineExecutionId
        required: false
        schema:
          type: string
      - in: query
        name: metricsAccountName
        required: false
        schema:
          type: string
      - in: query
        name: storageAccountName
        required: false
        schema:
          type: string
      - in: query
        name: configurationAccountName
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: {}
              type: object
        required: true
      responses:
        '200':
          content:
            '*/*':
              schema:
                additionalProperties: {}
                type: object
          description: OK
      summary: Start a canary execution
      tags:
      - v-2-canary-controller
  /v2/canaries/canary/{canaryConfigId}/{canaryExecutionId}:
    get:
      deprecated: true
      operationId: getCanaryResult_1
      parameters:
      - in: path
        name: canaryConfigId
        required: true
        schema:
          type: string
      - in: path
        name: canaryExecutionId
        required: true
        schema:
          type: string
      - in: query
        name: storageAccountName
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                additionalProperties: {}
                type: object
          description: OK
      summary: (DEPRECATED) Retrieve a canary result
      tags:
      - v-2-canary-controller
  /v2/canaries/canary/{canaryExecutionId}:
    get:
      operationId: getCanaryResult
      parameters:
      - in: path
        name: canaryExecutionId
        required: true
        schema:
          type: string
      - in: query
        name: storageAccountName
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                additionalProperties: {}
                type: object
          description: OK
      summary: Retrieve a canary result
      tags:
      - v-2-canary-controller
  /v2/canaries/credentials:
    get:
      operationId: listCredentials
      responses:
        '200':
          content:
            '*/*':
              schema:
                items: {}
                type: array
          description: OK
      summary: Retrieve a list of configured Kayenta accounts
      tags:
      - v-2-canary-controller
  /v2/canaries/judges:
    get:
      operationId: listJudges
      responses:
        '200':
          content:
            '*/*':
              schema:
                items: {}
                type: array
          description: OK
      summary: Retrieve a list of all configured canary judges
      tags:
      - v-2-canary-controller
  /v2/canaries/metadata/metricsService:
    get:
      operationId: listMetricsServiceMetadata
      parameters:
      - in: query
        name: filter
        required: false
        schema:
          type: string
      - in: query
        name: metricsAccountName
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                items: {}
                type: array
          description: OK
      summary: Retrieve a list of descriptors for use in populating the canary config ui
      tags:
      - v-2-canary-controller
  /v2/canaries/metricSetPairList/{metricSetPairListId}:
    get:
      operationId: getMetricSetPairList
      parameters:
      - in: path
        name: metricSetPairListId
        required: true
        schema:
          type: string
      - in: query
        name: storageAccountName
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                items: {}
                type: array
          description: OK
      summary: Retrieve a metric set pair list
      tags:
      - v-2-canary-controller
  /v2/canaries/{application}/executions:
    get:
      operationId: getCanaryResultsByApplication
      parameters:
      - in: path
        name: application
        required: true
        schema:
          type: string
      - in: query
        name: limit
        required: true
        schema:
          format: int32
          type: integer
      - in: query
        name: page
        required: false
        schema:
          default: 1
          format: int32
          type: integer
      - description: 'Comma-separated list of statuses, e.g.: RUNNING, SUCCEEDED, TERMINAL'
        in: query
        name: statuses
        required: false
        schema:
          type: string
      - in: query
        name: storageAccountName
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                items: {}
                type: array
          description: OK
      summary: Retrieve a list of an application's canary results
      tags:
      - v-2-canary-controller
externalDocs:
  description: Spinnaker Documentation
  url: https://spinnaker.io