Forta Health

Forta Health Field Templates API

The field_templates API from Forta Health — 2 operation(s) for field_templates.

GitHub OpenAPI

Operations 3

GET /api/v1/field_templates/fields/ List Fields #
GET /api/v1/field_templates/{identifier}/ Get Field Template #
PUT /api/v1/field_templates/{identifier}/ Upsert Field Template #

Documentation

📖
Authentication
https://artifacts.apis.io/forta-health/authentication/forta-health-authentication.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/forta-health/openapi/forta-health-field-templates-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://artifacts.apis.io/forta-health/errors/forta-health-problem-types.yml
🔗
Conventions
https://artifacts.apis.io/forta-health/conventions/forta-health-conventions.yml
🔗
DataModel
https://artifacts.apis.io/forta-health/data-model/forta-health-data-model.yml

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/forta-health:forta-health-field-templates-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

forta-health-field-templates-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Fast Field Templates API
  version: 0.1.0
tags:
- name: Field Templates
paths:
  /api/v1/field_templates/fields/:
    get:
      tags:
      - Field Templates
      summary: List Fields
      description: List catalog fields, optionally filtered by resource and enriched with templates.
      operationId: list_fields_api_v1_field_templates_fields__get
      security:
      - HTTPBearer: []
      parameters:
      - name: resource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter to fields belonging to this resource value.
          title: Resource
        description: Filter to fields belonging to this resource value.
      - name: with_template
        in: query
        required: false
        schema:
          type: boolean
          description: Append each field's saved template content.
          default: false
          title: With Template
        description: Append each field's saved template content.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FieldResponse'
                title: Response List Fields Api V1 Field Templates Fields  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/field_templates/{identifier}/:
    get:
      tags:
      - Field Templates
      summary: Get Field Template
      description: Get the template bound to a field by its unique identifier (template is null if unset).
      operationId: get_field_template_api_v1_field_templates__identifier___get
      security:
      - HTTPBearer: []
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          type: string
          title: Identifier
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldTemplateResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - Field Templates
      summary: Upsert Field Template
      description: Create or replace the template bound to a field (sanitized server-side).
      operationId: upsert_field_template_api_v1_field_templates__identifier___put
      security:
      - HTTPBearer: []
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          type: string
          title: Identifier
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FieldTemplateUpsertRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldTemplateResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    FieldTemplateUpsertRequest:
      properties:
        content:
          type: string
          maxLength: 50000
          minLength: 1
          title: Content
      type: object
      required:
      - content
      title: FieldTemplateUpsertRequest
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    FieldResponse:
      properties:
        resource:
          type: string
          title: Resource
        identifier:
          type: string
          title: Identifier
        value:
          type: string
          title: Value
        label:
          type: string
          title: Label
        template:
          anyOf:
          - type: string
          - type: 'null'
          title: Template
        date_row_created:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Date Row Created
        date_row_updated:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Date Row Updated
        resource_label:
          type: string
          title: Resource Label
      type: object
      required:
      - resource
      - identifier
      - value
      - label
      - resource_label
      title: FieldResponse
      description: 'A field in the catalog, optionally enriched with its template content.


        ``template`` and the timestamps describe the bound template and are only

        populated when ``with_template=true`` is requested AND a template exists;

        otherwise they are ``None``. Shape is identical whether or not the list was

        filtered by resource, so the client can rely on it.'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    FieldTemplateResponse:
      properties:
        resource:
          type: string
          title: Resource
        identifier:
          type: string
          title: Identifier
        value:
          type: string
          title: Value
        label:
          type: string
          title: Label
        template:
          anyOf:
          - type: string
          - type: 'null'
          title: Template
        date_row_created:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Date Row Created
        date_row_updated:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Date Row Updated
      type: object
      required:
      - resource
      - identifier
      - value
      - label
      title: FieldTemplateResponse
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-provenance:
  method: harvested
  publisher: Forta Health
  source: https://api.prod.fortahealth.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)