Cyware Ping API

Ping

OpenAPI Specification

cyware-ping-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Cyware Intel Exchange (CTIX) v3 Open Ping API
  version: 3.6.2
  description: 'Public Open API for Cyware Intel Exchange (formerly CTIX), Cyware''s threat intelligence platform for the ingestion, enrichment, analysis, correlation and bi-directional sharing of structured and unstructured threat intelligence using STIX 2.x and TAXII 2.x. The API covers threat data objects, intel creation and import, enrichment, rules, tags, watchlists, threat bulletins, threat investigation, dashboards, reports, PIR management, MITRE ATT&CK navigator data and platform administration.


    Intel Exchange is deployed per tenant, so the server host is the customer''s own Intel Exchange deployment; the API is mounted under `/ctixapi`.


    This document was assembled by API Evangelist from Cyware''s own published, structured API reference documents at https://ctixapiv3.cyware.com — each endpoint page is served as machine-readable markdown carrying a JSON endpoint model, and every page is indexed from that host''s llms.txt. Paths, methods, parameters, descriptions, enumerations and examples are reproduced from those documents; nothing is invented.'
  contact:
    name: Cyware
    url: https://www.cyware.com/contact-us
  termsOfService: https://www.cyware.com/legal/terms-of-use
  x-apievangelist-source: https://ctixapiv3.cyware.com/llms.txt
  x-apievangelist-method: generated
servers:
- url: https://{ctix_host}/ctixapi
  description: Tenant Intel Exchange deployment. Replace {ctix_host} with your own Intel Exchange host. Cyware documents the base URL form https://sample.domain.com/ctixapi in its authentication guide and uses https://demo.cyware.com/ctix/ as the example host in the config of its open-source MCP server.
  variables:
    ctix_host:
      default: demo.cyware.com
security:
- ctixOpenApiSignature: []
tags:
- name: Ping
  description: Ping
paths:
  /ping/:
    get:
      operationId: pingOpenapi
      summary: Get Ping OpenAPI
      tags:
      - Ping
      description: Checks the server connectivity through OpenAPI credentials.
      externalDocs:
        description: Cyware Intel Exchange API reference
        url: https://ctixapiv3.cyware.com/ping/ping-openapi
      parameters:
      - name: AccessID
        in: query
        required: false
        schema:
          type: string
          description: Pass the access ID associated with OpenAPI Credentials.
          examples:
          - '{accessid}'
        description: Pass the access ID associated with OpenAPI Credentials.
      - name: Signature
        in: query
        required: false
        schema:
          type: string
          description: Pass the signature generated by using Access ID and Secret Key.
          examples:
          - '{signature}'
        description: Pass the signature generated by using Access ID and Secret Key.
      - name: Expires
        in: query
        required: false
        schema:
          type: string
          description: Pass the expiry time is the time for which the signature remains valid.
          examples:
          - '{expires}'
        description: Pass the expiry time is the time for which the signature remains valid.
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: string
                    description: Returns the pong response, which means connectivity to the server has been established.
                    examples:
                    - pong
              example:
                result: pong
      x-alternate-documents:
      - title: Ping
        operationId: ping
        url: https://ctixapiv3.cyware.com/ping/ping
components:
  securitySchemes:
    ctixOpenApiSignature:
      type: apiKey
      in: query
      name: AccessID
      description: 'Intel Exchange Open API credentials. Every request carries three query parameters: AccessID (the access ID of the Open API credential), Expires (an epoch timestamp, at most 30 seconds in the future) and Signature - an HMAC-SHA1 of "AccessID\nExpires" keyed with the secret key, Base64 encoded and then URL encoded. See https://ctixapiv3.cyware.com/authentication'
externalDocs:
  description: Cyware Intel Exchange API Reference
  url: https://ctixapiv3.cyware.com/