Blockdaemon Target API

openapi: 3.2.0
info:
  version: 1.0.0
  title: Event Streaming Target API
  description: Creates and manages config for event streams
  contact:
    name: Blockdaemon
    email: info@blockdaemon.com
    url: https://blockdaemon.com
  x-logo:
    url: https://storage.googleapis.com/blockdaemon-app-static-images/marketing/PNG/dark-logo.png
    altText: Blockdaemon logo
servers:
- url: https://svc.blockdaemon.com
security:
- bearerAuth: []
- apiKeyAuthHeader: []
tags:
- name: Target
paths:
  /streaming/v2/targets:
    x-zuplo-path:
      pathMode: open-api
    get:
      tags:
      - Target
      summary: Get all Targets
      description: Returns a list of all targets you have access to, including details like status, type, and destination settings.
      operationId: findTargets
      responses:
        '200':
          description: Successful response with a list of targets
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Target'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-zuplo-route:
        custom:
          product: ub_event_streaming
          fh: ubiquity
          target_service: stream-configurator
          cluster: use4
          billing_product: event-streaming
        corsPolicy: anything-goes
        handler:
          export: urlRewriteHandler
          module: $import(@zuplo/runtime)
          options:
            rewritePattern: service://bd-workloads-${context.custom.cluster}-k8s-cluster-aegis-stream-configurator-${env.UB_ENV}/targets
        policies:
          inbound:
          - event-streaming-default-policy
          outbound: []
      x-operation-id-source: normalized
      x-operation-id-original: find targets
    post:
      tags:
      - Target
      summary: Create a Target
      description: Creates a new target. Duplicate targets are not allowed.
      operationId: addTarget
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewTarget'
      responses:
        '201':
          description: Target created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Target'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-zuplo-route:
        custom:
          product: ub_event_streaming
          fh: ubiquity
          target_service: stream-configurator
          billing_product: event-streaming
        corsPolicy: anything-goes
        handler:
          export: urlRewriteHandler
          module: $import(@zuplo/runtime)
          options:
            rewritePattern: service://bd-workloads-${context.custom.cluster}-k8s-cluster-aegis-stream-configurator-${env.UB_ENV}/targets
        policies:
          inbound:
          - event-streaming-default-policy
          outbound: []
      x-operation-id-source: normalized
      x-operation-id-original: add target
  /streaming/v2/targets/{id}:
    x-zuplo-path:
      pathMode: open-api
    get:
      tags:
      - Target
      summary: Get Target by ID
      description: Fetch a specific target using its ID. The request will return an error if the user doesn’t have access to the target.
      operationId: findTargetById
      parameters:
      - name: id
        in: path
        description: ID of target to fetch
        required: true
        schema:
          type: string
          format: uuid
          x-go-type: myuuid.UUID
          x-go-type-import:
            name: myuuid
            path: github.com/google/uuid
      responses:
        '200':
          description: Target retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Target'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-zuplo-route:
        custom:
          product: ub_event_streaming
          fh: ubiquity
          target_service: stream-configurator
          billing_product: event-streaming
        corsPolicy: anything-goes
        handler:
          export: urlRewriteHandler
          module: $import(@zuplo/runtime)
          options:
            rewritePattern: service://bd-workloads-${context.custom.cluster}-k8s-cluster-aegis-stream-configurator-${env.UB_ENV}/targets/${params.id}
        policies:
          inbound:
          - event-streaming-default-policy
          outbound: []
      x-operation-id-source: normalized
      x-operation-id-original: find target by id
    delete:
      tags:
      - Target
      summary: Delete a Target
      description: Delete a target using its ID.
      operationId: deleteTarget
      parameters:
      - name: id
        in: path
        description: ID of target to delete
        required: true
        schema:
          type: string
          format: uuid
          x-go-type: myuuid.UUID
          x-go-type-import:
            name: myuuid
            path: github.com/google/uuid
      responses:
        '204':
          description: Target deleted
        default:
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-zuplo-route:
        custom:
          product: ub_event_streaming
          fh: ubiquity
          target_service: stream-configurator
          billing_product: event-streaming
        corsPolicy: anything-goes
        handler:
          export: urlRewriteHandler
          module: $import(@zuplo/runtime)
          options:
            rewritePattern: service://bd-workloads-${context.custom.cluster}-k8s-cluster-aegis-stream-configurator-${env.UB_ENV}/targets/${params.id}
        policies:
          inbound:
          - event-streaming-default-policy
          outbound: []
      x-operation-id-source: normalized
      x-operation-id-original: delete target
    put:
      tags:
      - Target
      summary: Update a Target
      description: Updates an existing target using by ID. All fields will be replaced with the new values provided in the request body.
      operationId: updateTarget
      parameters:
      - name: id
        in: path
        description: ID of target to fetch
        required: true
        schema:
          type: string
          format: uuid
          x-go-type: myuuid.UUID
          x-go-type-import:
            name: myuuid
            path: github.com/google/uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewTarget'
      responses:
        '200':
          description: Target updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Target'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-zuplo-route:
        custom:
          product: ub_event_streaming
          fh: ubiquity
          target_service: stream-configurator
          billing_product: event-streaming
        corsPolicy: anything-goes
        handler:
          export: urlRewriteHandler
          module: $import(@zuplo/runtime)
          options:
            rewritePattern: service://bd-workloads-${context.custom.cluster}-k8s-cluster-aegis-stream-configurator-${env.UB_ENV}/targets/${params.id}
        policies:
          inbound:
          - event-streaming-default-policy
          outbound: []
      x-operation-id-source: normalized
      x-operation-id-original: update target
    patch:
      tags:
      - Target
      summary: Partially Update a Target
      description: Update some fields of a target using its ID. Include only the fields to be changed in the request body.
      operationId: patchTarget
      parameters:
      - name: id
        in: path
        description: ID of target to fetch
        required: true
        schema:
          type: string
          format: uuid
          x-go-type: myuuid.UUID
          x-go-type-import:
            name: myuuid
            path: github.com/google/uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchTarget'
      responses:
        '200':
          description: Target updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Target'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-zuplo-route:
        custom:
          product: ub_event_streaming
          fh: ubiquity
          target_service: stream-configurator
          billing_product: event-streaming
        corsPolicy: anything-goes
        handler:
          export: urlRewriteHandler
          module: $import(@zuplo/runtime)
          options:
            rewritePattern: service://bd-workloads-${context.custom.cluster}-k8s-cluster-aegis-stream-configurator-${env.UB_ENV}/targets/${params.id}
        policies:
          inbound:
          - event-streaming-default-policy
          outbound: []
      x-operation-id-source: normalized
      x-operation-id-original: patch target
  /streaming/v2/targets/{id}/logs:
    get:
      tags:
      - Target
      summary: Get Target Logs
      description: Returns the logs associated with the specified target ID.
      operationId: getTargetLogsById
      parameters:
      - name: id
        in: path
        description: ID of the target to fetch logs for
        required: true
        schema:
          type: string
          format: uuid
          x-go-type: myuuid.UUID
          x-go-type-import:
            name: myuuid
            path: github.com/google/uuid
      - name: page_token
        in: query
        description: Page token for pagination
        schema:
          type: string
      - name: page_size
        in: query
        description: Number of log entries per page
        schema:
          type: number
          x-go-type: int32
          default: 10
          minimum: 1
          maximum: 100
      - name: timestamp
        in: query
        description: Filter logs by timestamp
        schema:
          type: string
      responses:
        '200':
          description: Logs returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TargetLogs'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-zuplo-route:
        custom:
          product: ub_event_streaming
          fh: ubiquity
          target_service: stream-configurator
          billing_product: event-streaming
        corsPolicy: anything-goes
        handler:
          export: urlRewriteHandler
          module: $import(@zuplo/runtime)
          options:
            rewritePattern: service://bd-workloads-${context.custom.cluster}-k8s-cluster-aegis-stream-configurator-${env.UB_ENV}/targets/${params.id}/logs
        policies:
          inbound:
          - event-streaming-default-policy
          outbound: []
      x-operation-id-source: normalized
      x-operation-id-original: get target logs by id
  /streaming/v2/targets/{id}/validate-message:
    x-zuplo-path:
      pathMode: open-api
    post:
      tags:
      - Target
      summary: Validate Message for Target
      description: Sends a message template to the specified target and returns whether the message is valid.
      operationId: validateMessageSend
      parameters:
      - name: id
        in: path
        description: ID of the target to validate
        required: true
        schema:
          type: string
          format: uuid
          x-go-type: myuuid.UUID
          x-go-type-import:
            name: myuuid
            path: github.com/google/uuid
      requestBody:
        description: Template payload used for validation
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateTarget'
      responses:
        '200':
          description: Target Validated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateTargetResult'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-zuplo-route:
        custom:
          product: ub_event_streaming
          fh: ubiquity
          target_service: stream-configurator
          billing_product: event-streaming
        corsPolicy: anything-goes
        handler:
          export: urlRewriteHandler
          module: $import(@zuplo/runtime)
          options:
            rewritePattern: service://bd-workloads-${context.custom.cluster}-k8s-cluster-aegis-stream-configurator-${env.UB_ENV}/targets/${params.id}/validate-message
        policies:
          inbound:
          - event-streaming-default-policy
          outbound: []
      x-operation-id-source: normalized
      x-operation-id-original: validate message send
  /streaming/v2/targets/{id}/validate-verification:
    x-zuplo-path:
      pathMode: open-api
    post:
      tags:
      - Target
      summary: Test Target Connection
      description: Sends a test request to the specified Target to verify it can successfully receive messages.
      operationId: validateVerification
      parameters:
      - name: id
        in: path
        description: ID of the Target to verify
        required: true
        schema:
          type: string
          format: uuid
          x-go-type: myuuid.UUID
          x-go-type-import:
            name: myuuid
            path: github.com/google/uuid
      responses:
        '200':
          description: Verification response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateTargetResult'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-zuplo-route:
        custom:
          product: ub_event_streaming
          fh: ubiquity
          target_service: stream-configurator
          billing_product: event-streaming
        corsPolicy: anything-goes
        handler:
          export: urlRewriteHandler
          module: $import(@zuplo/runtime)
          options:
            rewritePattern: service://bd-workloads-${context.custom.cluster}-k8s-cluster-aegis-stream-configurator-${env.UB_ENV}/targets/${params.id}/validate-verification
        policies:
          inbound:
          - event-streaming-default-policy
          outbound: []
      x-operation-id-source: normalized
      x-operation-id-original: validate verification
components:
  schemas:
    Pagination:
      type: object
      properties:
        prev_page_token:
          type: string
        next_page_token:
          type: string
    PreDefinedTemplate:
      title: Predefined Template
      description: Available predefined templates that can be used for event formatting
      type: string
      enum:
      - UNIFIED_V1
      - UNIFIED_V1_RAW
      - ALL_DATA
      - INPUT_EMAIL
      - OUTPUT_EMAIL
      - TX_EMAIL
    TargetLog:
      type: object
      required:
      - event_type
      - timestamp
      - details
      properties:
        event_type:
          type: string
        timestamp:
          type: string
        details:
          type: string
          x-go-type: json.RawMessage
    MaxBufferCount:
      type: integer
      default: 10000
      minimum: 10
      maximum: 10000
      description: Maximum number of events that can be buffered before delivery.
    NewTarget:
      type: object
      required:
      - name
      - type
      - settings
      properties:
        name:
          type: string
          description: The name of the target
        description:
          type: string
          description: Optional information about the target
        status:
          type: string
          default: active
          enum:
          - disconnected
          - active
          - failed
          description: Current status of the target
        type:
          type: string
          enum:
          - webhook
          - websocket
          description: The type of target, indicating the communication protocol.
        settings:
          anyOf:
          - $ref: '#/components/schemas/WebhookSettings'
          - $ref: '#/components/schemas/WebsocketSettings'
          - $ref: '#/components/schemas/EmailSettings'
          description: Configuration settings specific to the target type.
        max_buffer_count:
          $ref: '#/components/schemas/MaxBufferCount'
    Target:
      type: object
      required:
      - id
      - name
      - type
      - status
      - settings
      - max_buffer_count
      - current_buffer_count
      properties:
        id:
          type: string
          format: uuid
          x-go-type: myuuid.UUID
          x-go-type-import:
            name: myuuid
            path: github.com/google/uuid
        name:
          type: string
        description:
          type: string
        status:
          type: string
          enum:
          - disconnected
          - active
          - connected
          - failed
        type:
          type: string
          enum:
          - webhook
          - websocket
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        settings:
          anyOf:
          - $ref: '#/components/schemas/WebhookSettings'
          - $ref: '#/components/schemas/WebsocketSettings'
          - $ref: '#/components/schemas/EmailSettings'
        max_buffer_count:
          $ref: '#/components/schemas/MaxBufferCount'
        current_buffer_count:
          type: integer
    ValidateTargetResult:
      type: object
      required:
      - status
      - duration
      properties:
        status:
          type: string
          enum:
          - success
          - failed
        error_status_code:
          type: integer
        error_response_message:
          type: string
        duration:
          type: string
    TargetLogs:
      type: object
      required:
      - logs
      - count
      properties:
        count:
          type: number
          x-go-type: int
        logs:
          type: array
          items:
            $ref: '#/components/schemas/TargetLog'
        pagination:
          $ref: '#/components/schemas/Pagination'
    Error:
      type: object
      x-go-type: ApiError
      x-go-name: ApiError
      required:
      - message
      - type
      - code
      - status
      - timestamp
      properties:
        type:
          type: string
          description: HTTP error type
          example: bad-request
        code:
          type: integer
          description: Numeric error code
          example: 16384
        status:
          type: integer
          description: HTTP status of the error
          example: 500
        message:
          type: string
          description: Long error description
          example: Oops theres been an internal error handling
        timestamp:
          type: string
          description: Long error description
          example: Oops theres been an internal error handling
    ID:
      description: An ID representing a specific template.
      type: string
      format: uuid
      x-go-type: myuuid.UUID
      x-go-type-import:
        name: myuuid
        path: github.com/google/uuid
    ValidateTarget:
      type: object
      required:
      - protocol
      - type
      - template
      properties:
        protocol:
          type: string
          description: The protocol used by the target (e.g., http, https, webhook).
        type:
          type: string
          description: The target type.
        template:
          $ref: '#/components/schemas/RuleTemplateRef'
    WebhookSettings:
      title: Webhook Settings
      description: Configuration for webhook-based targets. Includes the HTTP method, destination URL, and a secret used for signing and validating webhook messages.
      type: object
      required:
      - method
      - destination
      - secret
      properties:
        destination:
          type: string
          description: The destination URL where webhook events will be sent.
        method:
          type: string
          description: HTTP method used to deliver webhook events.
          enum:
          - POST
          - GET
        secret:
          type: string
          minLength: 10
          description: Secret key used to sign webhook payloads. Must be at least 10 characters long.
    WebsocketSettings:
      title: WebSocket Settings
      description: Configuration for WebSocket-based targets. Used to establish a connection and authenticate event delivery.
      type: object
      required:
      - type
      properties:
        secret:
          type: string
          minLength: 10
          description: Secret used to authenticate the WebSocket connection. Must be at least 10 characters long.
    PatchTarget:
      type: object
      properties:
        name:
          type: string
          description: New name for the target
        description:
          type: string
          description: Optional updated description of the target
        status:
          type: string
          enum:
          - disconnected
          - active
          - failed
          description: Updated status of the target
        type:
          type: string
          enum:
          - webhook
          - websocket
          description: The type of target to update. If changed, settings should match the new type
        max_buffer_count:
          type: integer
          minimum: 100
          maximum: 10000
          description: Maximum number of events that can be buffered before delivery
        settings:
          anyOf:
          - $ref: '#/components/schemas/WebhookSettings'
          - $ref: '#/components/schemas/WebsocketSettings'
          - $ref: '#/components/schemas/EmailSettings'
          description: Updated settings specific to the target type
    RuleTemplateRef:
      anyOf:
      - $ref: '#/components/schemas/ID'
      - $ref: '#/components/schemas/PreDefinedTemplate'
    EmailSettings:
      title: Email Settings
      description: Used to send notifications or alerts to a specified recipient via email.
      type: object
      required:
      - name
      - email
      properties:
        name:
          type: string
          description: The display name of the recipient.
        email:
          type: string
          format: email
          description: The recipient's email address.
  securitySchemes:
    apiKeyAuthHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'Unlock higher TPS - Create your own API key in the [Blockdaemon App](https://app.blockdaemon.com).

        '
      x-default: 2go1YqUcuAr4WZ2-3WgSD3c7qpatZqQuNWhTVBldKZnTSUtw
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Opaque
      description: '[Legacy Auth] Unlock higher TPS - Create your own API key in the [Blockdaemon App](https://app.blockdaemon.com).

        '
      x-default: 2go1YqUcuAr4WZ2-3WgSD3c7qpatZqQuNWhTVBldKZnTSUtw
x-provenance:
  method: searched
  source: https://docs.blockdaemon.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.blockdaemon.com/reference/add-rule.md
  - https://docs.blockdaemon.com/reference/add-target.md
  - https://docs.blockdaemon.com/reference/add-variable-value.md
  - https://docs.blockdaemon.com/reference/add-variable.md
  - https://docs.blockdaemon.com/reference/delete-rule.md
  - https://docs.blockdaemon.com/reference/delete-target.md
  - https://docs.blockdaemon.com/reference/delete-variable-value-by-id.md
  - https://docs.blockdaemon.com/reference/delete-variable-value-by-value.md
  - https://docs.blockdaemon.com/reference/delete-variable.md
  - https://docs.blockdaemon.com/reference/find-rule-by-id.md
  - https://docs.blockdaemon.com/reference/find-rules.md
  - https://docs.blockdaemon.com/reference/find-target-by-id.md
  - https://docs.blockdaemon.com/reference/find-targets.md
  - https://docs.blockdaemon.com/reference/find-variable-by-id.md
  - https://docs.blockdaemon.com/reference/find-variable-values.md
  - https://docs.blockdaemon.com/reference/find-variables.md
  - https://docs.blockdaemon.com/reference/get-event-protocol-overview.md
  - https://docs.blockdaemon.com/reference/get-organization-audit-logs.md
  - https://docs.blockdaemon.com/reference/get-target-logs-by-id.md
  - https://docs.blockdaemon.com/reference/patch-target.md
  - https://docs.blockdaemon.com/reference/update-rule.md
  - https://docs.blockdaemon.com/reference/update-target.md
  - https://docs.blockdaemon.com/reference/update-variable.md
  - https://docs.blockdaemon.com/reference/validate-message-send.md
  - https://docs.blockdaemon.com/reference/validate-verification.md
  merge:
    pages: 25
    deduped: 140
    conflicts_kept_first: 0