> ## Documentation Index
> Fetch the complete documentation index at: https://docs.atollhq.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Run KPI HTTP sync now

> Human-admin-only. Defaults to dry-run preview. Writing an api_poll snapshot requires { "write_snapshot": true, "confirm": "write api_poll snapshot" }.



## OpenAPI

````yaml /openapi.json post /api/orgs/{id}/kpis/{kpiId}/http-syncs/{syncId}/run-now
openapi: 3.1.0
info:
  title: Atoll API
  version: 1.0.0
  description: >-
    REST API for Atoll project management, agent collaboration, strategy
    tracking, and integrations.
servers:
  - url: https://atollhq.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Organizations
  - name: Projects
  - name: Project access
  - name: Issues
  - name: Issue details
  - name: Milestones
  - name: Strategy
  - name: Members and agents
  - name: Planning
  - name: Integrations and billing
  - name: Notifications and public
paths:
  /api/orgs/{id}/kpis/{kpiId}/http-syncs/{syncId}/run-now:
    post:
      tags:
        - Strategy
      summary: Run KPI HTTP sync now
      description: >-
        Human-admin-only. Defaults to dry-run preview. Writing an api_poll
        snapshot requires { "write_snapshot": true, "confirm": "write api_poll
        snapshot" }.
      operationId: post_api_orgs_id_kpis_kpiId_http_syncs_syncId_run_now
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: id identifier
        - name: kpiId
          in: path
          required: true
          schema:
            type: string
          description: kpiId identifier
        - name: syncId
          in: path
          required: true
          schema:
            type: string
          description: syncId identifier
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KpiHttpSyncRunNowInput'
        description: Defaults to preview. Snapshot writes require explicit confirmation.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                properties:
                  mode:
                    type: string
                    enum:
                      - preview
                      - write
                  result:
                    $ref: '#/components/schemas/KpiHttpSyncExecutionResult'
                  run:
                    type: object
                    additionalProperties: true
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - bearerAuth: []
components:
  schemas:
    KpiHttpSyncRunNowInput:
      type: object
      additionalProperties: false
      properties:
        write_snapshot:
          type: boolean
          description: Omit or false for preview. Must be true to write a snapshot.
        confirm:
          type: string
          enum:
            - write api_poll snapshot
          description: Required exactly when write_snapshot is true.
      description: >-
        Defaults to dry-run preview. Writing an api_poll snapshot requires both
        write_snapshot true and the exact confirm string.
    KpiHttpSyncExecutionResult:
      type: object
      additionalProperties: true
      properties:
        ok:
          type: boolean
        configHash:
          type: string
        httpStatus:
          type: integer
        durationMs:
          type: integer
        responseBytes:
          type: integer
        extractedValue:
          type: number
          nullable: true
        errorCode:
          type: string
      description: >-
        Sanitized execution result. Raw response bodies, secret values, and
        third-party payloads are never returned.
    Error:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
      required:
        - error
      additionalProperties: true
  responses:
    BadRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Authenticated but not allowed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found or not visible
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServerError:
      description: Unexpected server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: sk_atoll_<key>

````