---
title: "What this server speaks"
method: GET
path: "/v1/protocol"
tags: ["Assessments"]
---

# What this server speaks

`GET /v1/protocol`

## Request

- Base URL: `https://api.ironfang.com/security`
- URL: `https://api.ironfang.com/security/v1/protocol`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Supported protocol versions, limits, vocabularies (source types, asset types, categories, classification schemes, evidence kinds, sensitivities, statuses) and the remediation action registry, so a producer can check before it sends.

## Response `200`

The protocol.

- Protocol
  - `asset_types` string[], required
  - `categories` string[], required
  - `classification_schemes` string[], required
  - `current` integer, required
  - `evidence_kinds` string[], required
  - `finding_statuses` string[], required
  - `fingerprint` string, required: The first line of every fingerprint's input.
  - `limits` object, required
  - `protocol_versions` integer[], required
  - `remediation_actions` RemediationAction[], required
    - `available` boolean: A producer attached to the finding's asset advertises this action and was seen in the last seven days.
    - `description` string, required
    - `id` string, required: e.g. wordpress.update_plugin.
    - `parameters` union
      - object: On a finding, the values this finding gives the action.
      - string[]: In the registry, the parameter names the action takes.
    - `requires_confirmation` boolean, required
    - `restart` 'none' | 'service' | 'workload' | 'host', required
    - `reversible` boolean, required
    - `risk` 'low' | 'medium' | 'high', required
    - `title` string, required
  - `sensitivities` string[], required
  - `source_types` object[], required
    - `auto_resolves` boolean, required
    - `ironfang_namespace` boolean, required
    - `manually_resolvable` boolean, required
    - `name` string, required
    - `type` 'external_scan' | 'wordpress_agent' | 'linux_agent' | 'kubernetes_agent' | 'container_scanner' | 'cloud_integration' | 'dependency_scanner' | 'ai_assessment' | 'nuclei' | 'import' | 'manual', required: What kind of producer a result came from. external_scan is the External Security Check and cannot be submitted.

## Other responses

- `401`: An error.
- `403`: An error.
- `default`: An error.

---

[API](https://skmtc.dev/ironfang/apis/ironfang-security-api.md) · [All operations](https://skmtc.dev/ironfang/apis/ironfang-security-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ironfang/apis/ironfang-security-api/revisions/73bd66283d59?raw)