Canonical Secrets API

The Secrets API from Canonical — 1 operation(s) for secrets.

Operations 2

PUT /v1/secrets/{client_id}/{path} Store a secret value for the specified client_id and path #
DELETE /v1/secrets/{client_id}/{path} Remove a secret value for the specified client_id and path #

Documentation

Specifications

Other Resources

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/canonical-secrets-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.

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

OpenAPI Specification

canonical-secrets-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Testflinger Secrets API
  version: 1.0.0
servers:
- url: https://testflinger.ps7.canonical.com/
tags:
- name: Secrets
paths:
  /v1/secrets/{client_id}/{path}:
    put:
      parameters:
      - in: path
        name: client_id
        schema:
          type: string
        required: true
      - in: path
        name: path
        schema:
          type: string
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretOut'
          description: Successful response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: Validation error
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Not found
      tags:
      - Secrets
      summary: Store a secret value for the specified client_id and path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretIn'
      operationId: putV1SecretsByClientIdByPath
      x-operation-id-source: derived
    delete:
      parameters:
      - in: path
        name: client_id
        schema:
          type: string
        required: true
      - in: path
        name: path
        schema:
          type: string
        required: true
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful response
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Not found
      tags:
      - Secrets
      summary: Remove a secret value for the specified client_id and path
      operationId: deleteV1SecretsByClientIdByPath
      x-operation-id-source: derived
components:
  schemas:
    SecretIn:
      type: object
      properties:
        value:
          type: string
          minLength: 1
        expire_after:
          type:
          - integer
          - 'null'
          minimum: 1
        ephemeral:
          type: boolean
          default: false
      required:
      - value
      additionalProperties: false
    SecretOut:
      type: object
      properties:
        expires_at:
          type:
          - string
          - 'null'
          format: date-time
          description: UTC datetime for secret expiration if TTL is set.
      additionalProperties: false
    ValidationError:
      properties:
        detail:
          type: object
          properties:
            <location>:
              type: object
              properties:
                <field_name>:
                  type: array
                  items:
                    type: string
        message:
          type: string
      type: object
    HTTPError:
      properties:
        detail:
          type: object
        message:
          type: string
      type: object