Secureframe

Secureframe SSP Report Section Block API

This document describes the API for reading and updating SSP Report Section Blocks.

GitHub OpenAPI

Operations 3

GET /ssp_report_section_blocks List SSP Report Section Blocks #
GET /ssp_report_section_blocks/{id} Get an SSP Report Section Block #
PUT /ssp_report_section_blocks/{id} Update an SSP Report Section Block #

Documentation

📖
Documentation
https://developer.secureframe.com/
📖
APIReference
https://api.secureframe.com/docs
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/secureframe/refs/heads/main/authentication/secureframe-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/secureframe/refs/heads/main/rate-limits/secureframe-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/secureframe/refs/heads/main/openapi/secureframe-ssp-report-section-block-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/secureframe/refs/heads/main/errors/secureframe-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/secureframe/refs/heads/main/conventions/secureframe-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/secureframe/refs/heads/main/data-model/secureframe-data-model.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/secureframe/refs/heads/main/lifecycle/secureframe-lifecycle.yml
🔗
Deprecation
https://raw.githubusercontent.com/api-evangelist/secureframe/refs/heads/main/lifecycle/secureframe-lifecycle.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/secureframe-ssp-report-section-block-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

secureframe-ssp-report-section-block-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Secureframe SSP Report Section Block API
  description: '## Introduction


    Secureframe exposes a REST API for use by customers, partners, and community developers.'
  version: '2023-10-18'
  x-logo:
    url: https://media.secureframe.com/logo-dark.svg
servers:
- url: https://api.secureframe.com
- url: https://api-uk.secureframe.com
tags:
- name: SSP Report Section Block
  description: This document describes the API for reading and updating SSP Report Section Blocks.
paths:
  /ssp_report_section_blocks:
    get:
      tags:
      - SSP Report Section Block
      operationId: companySspReportSectionBlocksIndex
      parameters:
      - name: page
        description: 'Used for pagination of response data (default: page 1). Specifies the offset of the next block of data to receive.'
        required: false
        in: query
        schema:
          type: integer
      - name: per_page
        description: 'Used for pagination of response data (default: 100 items per response). Specifies the number of results for a given page.'
        required: false
        in: query
        schema:
          type: integer
      - name: q
        description: Search and filter the SSP Report Section Block data using Lucene syntax.
        required: false
        in: query
        schema:
          type: string
      - name: sort
        description: 'Field to sort the results by. Prefix it with `-` to sort in descending order, for example `?sort=-block_key`. This endpoint sorts on one field only — supplying more than one comma delimited field returns a 400. Sortable fields: `block_key`, `block_type`, `created_at`, `id`, `ssp_report_id`, `ssp_report_section_id`, `updated_at`.'
        required: false
        in: query
        schema:
          type: string
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    description: List of resources matching the query
                    items:
                      type: object
                      description: Data envelope for the response
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: The identifier for this resource
                        type:
                          type: string
                          description: The type of resource this object is
                        attributes:
                          $ref: '#/components/schemas/SspReportSectionBlock'
                        relationships:
                          type: object
                          description: Nested objects related to the top level object
                        links:
                          type: object
                          description: Links to related API resources
                  meta:
                    type: object
                    description: Metadata about the list response
                    properties:
                      total:
                        type: integer
                        description: Total number of records matching the query across all pages, independent of page and per_page
                  included:
                    type: array
                    items:
                      type: object
                      description: Various objects that have been included via the `include` param
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: The identifier for this resource
        '403':
          description: Forbidden
        '401':
          description: Unauthorized
        '400':
          description: Bad Request
      description: 'Returns a list of SSP Report Section Blocks.

        ### Search parameters


        - `block_key` — The block key of the SSP Report Section Block

        - `block_type` — The block type of the SSP Report Section Block

        - `created_at` — The date when this SSP Report Section Block was created

        - `id` — The ID of the SSP Report Section Block

        - `ssp_report_id` — The ID of the associated SSP report

        - `ssp_report_section_id` — The ID of the associated SSP report section

        - `updated_at` — The date when this SSP Report Section Block was last updated'
      summary: List SSP Report Section Blocks
      security:
      - header_authorization: []
      x-controller: api/company_ssp_report_section_blocks
      x-action: index
  /ssp_report_section_blocks/{id}:
    get:
      tags:
      - SSP Report Section Block
      operationId: companySspReportSectionBlocksShow
      parameters:
      - name: id
        description: Scope response to id
        required: true
        in: path
        schema:
          type: string
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    description: Data envelope for the response
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: The identifier for this resource
                      type:
                        type: string
                        description: The type of resource this object is
                      attributes:
                        $ref: '#/components/schemas/SspReportSectionBlock'
                      relationships:
                        type: object
                        description: Nested objects related to the top level object
                      links:
                        type: object
                        description: Links to related API resources
                  included:
                    type: array
                    items:
                      type: object
                      description: Various objects that have been included via the `include` param
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: The identifier for this resource
        '404':
          description: Resource not found
        '403':
          description: Forbidden
        '401':
          description: Unauthorized
        '400':
          description: Bad Request
      description: Returns an SSP Report Section Block by ID
      summary: Get an SSP Report Section Block
      security:
      - header_authorization: []
      x-controller: api/company_ssp_report_section_blocks
      x-action: show
    put:
      tags:
      - SSP Report Section Block
      operationId: companySspReportSectionBlocksUpdate
      parameters:
      - name: id
        description: Scope response to id
        required: true
        in: path
        schema:
          type: string
      - name: value
        description: 'The value for this block. Shape depends on block_type: a scalar for input/textarea/select/checkbox/color_picker/website_extractor, an array for multiselect, or an array of contact objects for contacts.'
        required: false
        in: query
        schema:
          type: object
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    description: Data envelope for the response
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: The identifier for this resource
                      type:
                        type: string
                        description: The type of resource this object is
                      attributes:
                        $ref: '#/components/schemas/SspReportSectionBlock'
                      relationships:
                        type: object
                        description: Nested objects related to the top level object
                      links:
                        type: object
                        description: Links to related API resources
                  included:
                    type: array
                    items:
                      type: object
                      description: Various objects that have been included via the `include` param
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: The identifier for this resource
        '404':
          description: Resource not found
        '403':
          description: Forbidden
        '401':
          description: Unauthorized
        '400':
          description: Bad Request
      description: Update an SSP Report Section Block's value by ID
      summary: Update an SSP Report Section Block
      security:
      - header_authorization: []
      x-controller: api/company_ssp_report_section_blocks
      x-action: update
components:
  schemas:
    SspReportSectionBlock:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The identifier for this SSP Report Section Block.
        block_key:
          type: string
          description: The semantic key identifying what this block represents.
        block_type:
          type: string
          description: The type of the block (e.g. input, textarea, select, multiselect, contacts).
        child_block_ids:
          type: array
          items:
            type: string
          description: The ordered IDs of this block's child blocks.
        required:
          type: boolean
          description: Whether this block is required for section completion.
        ssp_report_id:
          type: string
          format: uuid
          description: The identifier for the associated SSP report.
        ssp_report_section_id:
          type: string
          format: uuid
          description: The identifier for the associated SSP report section.
        value:
          type: object
          description: The current value of the block.
  securitySchemes:
    header_authorization:
      type: apiKey
      name: Authorization
      in: header
x-tagGroups:
- name: Endpoints
  tags:
  - Cloud Resource
  - Cloud Resource Framework Asset Scope
  - Comment
  - Control
  - Custom Integration
  - Device
  - Device Framework Asset Scope
  - Evidence
  - File Upload
  - Framework
  - Framework Requirement
  - Integration Connection
  - Knowledge Base Answer
  - Knowledge Base Question
  - POA&M Item
  - Policy
  - Repository
  - Repository Framework Asset Scope
  - Risk
  - SSP Duty
  - SSP Duty Role
  - SSP Policy
  - SSP Report
  - SSP Report Assessment Objective
  - SSP Report Section
  - SSP Report Section Block
  - SSP Role
  - SSP Vendor
  - Security Questionnaire
  - Task
  - Test
  - Test Evidence
  - Test Export
  - Test Export Reading
  - Third Party Risk Management Vendor
  - Trust Center Request
  - User
  - User Account
  - User Evidence
  - User Security Settings
  - Vendor