openapi: 3.2.0
info:
  title: SpringServe UI API (V0) Keys API
  version: 0.1.0
  description: "> **_NOTE:_** This document covers the v0 API (`/api/v0`). You can find additional documentation on the v0 API (`/api/v0`) on the \n[Magnite Help Center](https://help.magnite.com/), which is broken into sections for endpoints relevant to \n[SpringServe](https://help.magnite.com/help/api-documentation) and [Clearline](https://help.magnite.com/help/api-documentation-06dd4d3). \nYou can also find V1 swagger documentation by selecting ‘SpringServe API V1’ from the dropdown at the top right corner \nof this page. Please note we are in the process of creating V1 endpoints for all existing V0 endpoints, but while that work \nis in progress not all endpoints will be supported on V1. We advise reviewing both swagger pages to determine what \nis supported in each version.\n\n# Authentication\nWhen using this API documentation server, by default it will authenticate API calls using cookie-based authentication agains the selected server.  If you are properly logged into the SpringServe server and your session is still active, then the API calls should automatically authenticate.  \n\nOutside of this API documentation server you should use either Token Based or Bearer authentication.  You may also these authentication methods on this server as well,\n which will take precedence over any cookie/session based authentication.\n### Token Based Authentication\nUse the [POST /api/v0/auth](#/Auth/auth_post) endpoint to generate an API token that is then passed in the `Authorization: <token>` header\n\n### Bearer Authentication\nUse the [POST /api/v0/auth](#/Auth/auth_post) endpoint to authenticate and get a bearer token that is then passed in the `Authorization: Bearer <token>` header\n\n# Active Account Context\nA given request always runs in the context of currently active account for the authenticated user making\nthe request. The active account can be determined via the [GET /api/v0/accounts/current](#/Accounts/accounts_current_get)\nendpoint and updated via [POST /api/v0/accounts/{id}/set_current](#/Accounts/accounts_id_set_current_post).\nThe active account can also be overridden for an authenticated request by passing the `x-auth-context` header.\n\n# V0 List Resource Functionality\nV0 list endpoints support pagination via the `page` (first page is page 1) and `per` (how many results\nper page) query parameters. Some endpoints also support filtering by `ids[]` (repeated query param, e.g. ids[]=1&ids[]=2).\n"
servers:
- url: https://console.springserve.com
  description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
- url: https://api.springserve.com
  description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
security:
- api_key: []
- bearer_token: []
tags:
- name: Keys
paths:
  /api/v0/keys:
    get:
      summary: Index
      parameters:
      - $ref: ref/params.yaml#/components/parameters/pageParam
      - $ref: ref/params.yaml#/components/parameters/perParam
      - $ref: ref/params.yaml#/components/parameters/idsParam
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: ref/schemas.yaml#/components/schemas/ListResponse
      tags:
      - Keys
      operationId: keys_get
    post:
      summary: Create
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              key_create_simple:
                $ref: '#/components/examples/key_create_simple'
              key_create_full:
                $ref: '#/components/examples/key_create_full'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Keys
      operationId: keys_post
  /api/v0/keys/{id}:
    get:
      summary: Show
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Keys
      operationId: keys_id_get
    put:
      summary: Update
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              key_update_simple:
                $ref: '#/components/examples/key_update_simple'
              key_update_full:
                $ref: '#/components/examples/key_update_full'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Keys
      operationId: keys_id_put
    delete:
      summary: Destroy
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No content
      tags:
      - Keys
      operationId: keys_id_delete
  /api/v0/keys/{key_id}/values:
    get:
      summary: Index
      parameters:
      - name: key_id
        in: path
        required: true
        schema:
          type: string
      - $ref: ref/params.yaml#/components/parameters/pageParam
      - $ref: ref/params.yaml#/components/parameters/perParam
      - $ref: ref/params.yaml#/components/parameters/idsParam
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: ref/schemas.yaml#/components/schemas/ListResponse
      tags:
      - Keys
      operationId: keys_key_id_values_get
    post:
      summary: Create
      parameters:
      - name: key_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              key_value_create_simple:
                $ref: '#/components/examples/key_value_create_simple'
              key_value_create_full:
                $ref: '#/components/examples/key_value_create_full'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Keys
      operationId: keys_key_id_values_post
  /api/v0/keys/{key_id}/values/{value_id}:
    get:
      summary: Show
      parameters:
      - name: key_id
        in: path
        required: true
        schema:
          type: string
      - name: value_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Keys
      operationId: keys_key_id_values_value_id_get
    put:
      summary: Update
      parameters:
      - name: key_id
        in: path
        required: true
        schema:
          type: string
      - name: value_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              key_value_update_simple:
                $ref: '#/components/examples/key_value_update_simple'
              key_value_update_full:
                $ref: '#/components/examples/key_value_update_full'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Keys
      operationId: keys_key_id_values_value_id_put
    patch:
      summary: Update
      parameters:
      - name: key_id
        in: path
        required: true
        schema:
          type: string
      - name: value_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              key_value_update_simple:
                $ref: '#/components/examples/key_value_update_simple'
              key_value_update_full:
                $ref: '#/components/examples/key_value_update_full'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Keys
      operationId: keys_key_id_values_value_id_patch
    delete:
      summary: Destroy
      parameters:
      - name: key_id
        in: path
        required: true
        schema:
          type: string
      - name: value_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No content
      tags:
      - Keys
      operationId: keys_key_id_values_value_id_delete
components:
  examples:
    key_update_simple:
      summary: Simple
      value:
        name: Key Name
    key_value_create_full:
      summary: Full
      value:
        name: Key Name
        value: my-value
    key_value_update_simple:
      summary: Simple
      value:
        name: Key Name
    key_create_full:
      summary: Full
      value:
        name: Key Name
        key: my-custom-key
        definition_type: predefined
        description: Key description
        log_level_reporting_only: false
        supply_client_reporting_enabled: true
        demand_client_reporting_enabled: true
        key_sharing_enabled: false
    key_value_update_full:
      summary: Full
      value:
        name: Key Name
        value: updated-value
    key_create_simple:
      summary: Simple
      value:
        name: Key Name
        key: my-custom-key
        definition_type: free
    key_update_full:
      summary: Full
      value:
        name: Key Name
        description: Updated key description
        log_level_reporting_only: false
        supply_client_reporting_enabled: true
        demand_client_reporting_enabled: true
        key_sharing_enabled: true
        key_sharing_other_account_ids:
        - 1
    key_value_create_simple:
      summary: Simple
      value:
        name: Key Name
        value: my-value
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: Authorization
      description: SpringServe authorization token based authentication.
    bearer_token:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: SpringServe authorization bearer token based authentication.  This key is included in the response from the /api/v0/auth and /api/v1/auth endpoints.  This key will be automatically set if you run the example for /api/v0/auth or /api/v1/auth