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/equinix-stream-subscriptions-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

openapi: 3.2.0
info:
  title: Equinix Fabric API v4 Stream Subscriptions API
  description: 'Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to: </br> 1. Cloud Service Providers - Clouds, network and other service providers.  </br> 2. Enterprises - Other Equinix customers, vendors and partners.  </br> 3. Myself - Another customer instance deployed at Equinix. </br> </br> <b>Integrations (SDKs, Tools) links:</b> </br> <a href="https://github.com/equinix/equinix-sdk-java">Fabric Java SDK</a> </br> <a href="https://github.com/equinix/equinix-sdk-go">Fabric Go SDK</a> </br> <a href="https://github.com/equinix/equinix-sdk-python">Fabric Python SDK</a> </br> <a href="https://registry.terraform.io/providers/equinix/equinix/latest/docs">Equinix Terraform Provider</a> </br> <a href="https://registry.terraform.io/modules/equinix/fabric/equinix/latest">Fabric Terraform Modules</a> </br> <a href="https://www.pulumi.com/registry/packages/equinix/">Equinix Pulumi Provider</a> </br>'
  termsOfService: https://www.equinix.com/about/legal/terms
  contact:
    name: Equinix API Support
    url: https://docs.equinix.com/api-support.htm
  license:
    name: Equinix Inc
    url: https://developer.equinix.com/agreement
  version: '4.28'
servers:
- url: https://api.equinix.com
  description: Equinix Inc
security:
- BearerAuth: []
tags:
- name: Stream Subscriptions
  description: Stream Subscriptions
paths:
  /fabric/v4/streams/{streamId}/subscriptions:
    get:
      tags:
      - Stream Subscriptions
      summary: Get Subscriptions
      description: This API provides capability to retrieve stream subscriptions
      operationId: getStreamSubscriptions
      parameters:
      - name: streamId
        in: path
        description: Stream UUID
        required: true
        schema:
          $ref: '#/components/schemas/StreamId'
      - name: offset
        in: query
        description: offset
        required: false
        schema:
          type: integer
        example: 1
      - name: limit
        in: query
        description: number of records to fetch
        required: false
        schema:
          type: integer
        example: 10
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllStreamSubscriptionResponse'
              examples:
                Example:
                  $ref: '#/components/examples/stream-subscription-get-all-example'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/404'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/500'
    post:
      tags:
      - Stream Subscriptions
      summary: Create Subscription
      description: This API provides capability to create user's Stream Subscriptions
      operationId: createStreamSubscriptions
      parameters:
      - name: streamId
        in: path
        description: Stream UUID
        required: true
        schema:
          $ref: '#/components/schemas/StreamId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StreamSubscriptionPostRequest'
            examples:
              CreateStreamSubscription_Splunk_Simple:
                $ref: '#/components/examples/StreamSubscriptionPostRequestExampleSimpleDefaultSplunk'
              CreateStreamSubscription_Splunk:
                $ref: '#/components/examples/StreamSubscriptionPostRequestExampleSplunk'
              CreateStreamSubscription_Slack:
                $ref: '#/components/examples/StreamSubscriptionPostRequestExampleSlack'
              CreateStreamSubscription_Pagerduty:
                $ref: '#/components/examples/StreamSubscriptionPostRequestExamplePagerduty'
              CreateStreamSubscription_Datadog:
                $ref: '#/components/examples/StreamSubscriptionPostRequestExampleDatadog'
              CreateStreamSubscription_Microsoft_Teams:
                $ref: '#/components/examples/StreamSubscriptionPostRequestExampleTeams'
              CreateStreamSubscription_Servicenow:
                $ref: '#/components/examples/StreamSubscriptionPostRequestExampleServicenow'
              CreateStreamSubscription_Webhook:
                $ref: '#/components/examples/StreamSubscriptionPostRequestExampleWebhook'
              CreateStreamSubscription_Grafana_Webhook:
                $ref: '#/components/examples/StreamSubscriptionPostRequestExampleGrafanaWebhook'
              CreateStreamSubscription_Google_PubSub:
                $ref: '#/components/examples/StreamSubscriptionPostRequestExampleGooglePubSub'
        required: true
      responses:
        '202':
          description: Stream Subscription object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamSubscription'
              examples:
                StreamSubscriptionResponse:
                  $ref: '#/components/examples/StreamSubscriptionResponseExample'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/403'
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/415'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/500'
  /fabric/v4/streams/{streamId}/subscriptions/{subscriptionId}:
    get:
      tags:
      - Stream Subscriptions
      summary: Get Subscription
      description: This API provides capability to delete user's get Stream Subscriptions
      operationId: getStreamSubscriptionByUuid
      parameters:
      - name: streamId
        in: path
        description: Stream UUID
        required: true
        schema:
          $ref: '#/components/schemas/StreamId'
      - name: subscriptionId
        in: path
        description: Stream Subscription UUID
        required: true
        schema:
          $ref: '#/components/schemas/StreamSubscriptionId'
      responses:
        '200':
          description: Stream Subscription object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamSubscription'
              examples:
                StreamSubscriptionResponse:
                  $ref: '#/components/examples/StreamSubscriptionResponseExample'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/404'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/500'
    put:
      tags:
      - Stream Subscriptions
      summary: Update Subscription
      description: This API provides capability to update user's Stream Subscriptions
      operationId: updateStreamSubscriptionByUuid
      parameters:
      - name: streamId
        in: path
        description: Stream UUID
        required: true
        schema:
          $ref: '#/components/schemas/StreamId'
      - name: subscriptionId
        in: path
        description: Stream Subscription UUID
        required: true
        schema:
          $ref: '#/components/schemas/StreamSubscriptionId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StreamSubscriptionPutRequest'
            examples:
              UpdateSubscription:
                $ref: '#/components/examples/StreamSubscriptionPutRequestExample'
        required: true
      responses:
        '202':
          description: Stream Subscription object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamSubscription'
              examples:
                StreamSubscriptionResponse:
                  $ref: '#/components/examples/StreamSubscriptionResponseExample'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/404'
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/415'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/500'
    delete:
      tags:
      - Stream Subscriptions
      summary: Delete Subscription
      description: This API provides capability to delete user's Stream Subscriptions
      operationId: deleteStreamSubscriptionByUuid
      parameters:
      - name: streamId
        in: path
        description: Stream UUID
        required: true
        schema:
          $ref: '#/components/schemas/StreamId'
      - name: subscriptionId
        in: path
        description: Stream Subscription UUID
        required: true
        schema:
          $ref: '#/components/schemas/StreamSubscriptionId'
      responses:
        '202':
          description: Stream Subscription object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamSubscription'
              examples:
                StreamSubscriptionResponse:
                  $ref: '#/components/examples/StreamSubscriptionDeleteResponseExample'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/404'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/500'
components:
  examples:
    StreamSubscriptionResponseExample:
      value:
        href: https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/subscriptions/d684aa26-8276-48b7-bb42-a6d9def0a418
        uuid: d684aa26-8276-48b7-bb42-a6d9def0a418
        type: STREAM_SUBSCRIPTION
        name: stream 1
        description: stream dec 1
        state: PROVISIONED
        enabled: true
        metricSelector:
          include:
          - equinix.fabric.connection.*
        eventSelector:
          include:
          - equinix.fabric.connection.*
        sink:
          uri: https://http-inputs-<host>.splunkcloud.com:<port>/services/collector/event
          type: SPLUNK_HEC
          credential:
            type: ACCESS_TOKEN
            accessToken: Splunk <my-access-token>
          settings:
            source: Equinix
            eventIndex: idx-hec-event
            metricIndex: idx-hec-metric
          batchEnabled: false
          batchSizeMax: 50
          batchWaitTimeMax: 5
        operation:
          eventsDeliveredCount: 0
          metricsDeliveredCount: 0
          alertsDeliveredCount: 0
          errors: []
        changeLog:
          createdDateTime: 2024-05-06 16:21:18.545214+00:00
    '404':
      value:
      - errorCode: EQ-3045811
        errorMessage: uuid not found
        correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515
        details: uuid not found
    StreamSubscriptionPostRequestExampleGrafanaWebhook:
      value:
        type: STREAM_SUBSCRIPTION
        name: webhook
        description: subscription-1
        enabled: true
        metricSelector:
          include:
          - equinix.fabric.connection.*
        sink:
          type: WEBHOOK
          settings:
            eventUri: https://<grafana_oltp_endpoint>/otlp/v1/logs
            metricUri: https://<grafana_oltp_endpoint>/otlp/v1/metrics
            format: OPENTELEMETRY
          credential:
            type: API_KEY
            apiKey: <granfana_instance_id>:<grafana_api_key>
    StreamSubscriptionPostRequestExampleGooglePubSub:
      value:
        type: STREAM_SUBSCRIPTION
        name: gcp-pubsub
        description: subscription-1
        enabled: true
        metricSelector:
          include:
          - equinix.fabric.connection.*
        sink:
          type: GOOGLE_PUBSUB
          uri: https://pubsub.googleapis.com/v1/projects/<gcp-project-name>/topics/<gcp-topic-name>:publish
          credential:
            type: ACCESS_TOKEN
            accessToken: <encoded-base64-gcp-service-account-json>
    StreamSubscriptionPostRequestExampleTeams:
      value:
        type: STREAM_SUBSCRIPTION
        name: teams1
        description: subscription-1
        enabled: true
        metricSelector:
          include:
          - equinix.fabric.connection.*
        eventSelector:
          include:
          - equinix.fabric.connection.*
        sink:
          uri: https://xxxxxx
          type: TEAMS
    stream-subscription-get-all-example:
      value:
        pagination:
          offset: 0
          limit: 20
          total: 1
        data:
        - href: https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/subscriptions/d684aa26-8276-48b7-bb42-a6d9def0a418
          uuid: d684aa26-8276-48b7-bb42-a6d9def0a418
          type: STREAM_SUBSCRIPTION
          name: splunk
          description: subscription 1
          state: PROVISIONED
          metricSelector:
            include:
            - equinix.fabric.connection.*
          eventSelector:
            include:
            - equinix.fabric.connection.*
          sink:
            uri: https://xxxxxx
            type: SPLUNK_HEC
            batchEnabled: false
            batchSizeMax: 50
            batchWaitTimeMax: 5
          operation:
            eventsDeliveredCount: 0
            metricsDeliveredCount: 0
            alertsDeliveredCount: 0
            errors: []
          changeLog:
            createdDateTime: 2024-05-06 16:21:18.545214+00:00
    StreamSubscriptionPostRequestExampleSlack:
      value:
        type: STREAM_SUBSCRIPTION
        name: slack1
        description: subscription-1
        enabled: true
        metricSelector:
          include:
          - equinix.fabric.connection.*
        eventSelector:
          include:
          - equinix.fabric.connection.*
        sink:
          uri: https://xxxxxx
          type: SLACK
    StreamSubscriptionPostRequestExampleDatadog:
      value:
        type: STREAM_SUBSCRIPTION
        name: datadog
        description: subscription-1
        enabled: true
        metricSelector:
          include:
          - equinix.fabric.connection.*
        sink:
          host: https://<xyz>.datadoghq.com
          type: DATADOG
          credential:
            type: API_KEY
            apiKey: my-api-key
          settings:
            source: Equinix
            applicationKey: my-application-key
            eventUri: https://<xyz>.datadoghq.com/api/v1/events
            metricUri: https://<xyz>.datadoghq.com/api/v2/series
    StreamSubscriptionPostRequestExampleSimpleDefaultSplunk:
      value:
        type: STREAM_SUBSCRIPTION
        name: splunk1
        description: subscription-1
        enabled: true
        sink:
          uri: https://http-inputs-<host>.splunkcloud.com:<port>/services/collector/event
          type: SPLUNK_HEC
          credential:
            type: ACCESS_TOKEN
            accessToken: Splunk <my-access-token>
          settings:
            source: Equinix
            eventIndex: idx-hec-event
            metricIndex: idx-hec-metric
    StreamSubscriptionPutRequestExample:
      value:
        name: splunk1
        description: subscription 1
        enabled: true
        metricSelector:
          include:
          - equinix.fabric.connection.*
        eventSelector:
          include:
          - equinix.fabric.connection.*
        sink:
          uri: https://xxxxxx
          type: SPLUNK_HEC
          credential:
            type: ACCESS_TOKEN
            accessToken: my-access-token
          settings:
            source: Equinix
            eventIndex: idx-hec-event
            metricIndex: idx-hec-metric
          batchEnabled: false
          batchSizeMax: 50
          batchWaitTimeMax: 5
    '403':
      value:
      - errorCode: EQ-3045003
        errorMessage: Operation not allowed
        correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515
        details: Operation not allowed for current user
    StreamSubscriptionDeleteResponseExample:
      value:
        href: https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/subscriptions/d684aa26-8276-48b7-bb42-a6d9def0a418
        uuid: d684aa26-8276-48b7-bb42-a6d9def0a418
        type: STREAM_SUBSCRIPTION
        name: stream 1
        description: stream dec 1
        state: DEPROVISIONING
        enabled: true
        metricSelector:
          include:
          - equinix.fabric.connection.*
        eventSelector:
          include:
          - equinix.fabric.connection.*
        sink:
          uri: https://xxxxxx
          type: SPLUNK_HEC
          credential:
            type: ACCESS_TOKEN
            accessToken: Splunk <my-access-token>
          settings:
            source: Equinix
            eventIndex: idx-hec-event
            metricIndex: idx-hec-metric
          batchEnabled: false
          batchSizeMax: 50
          batchWaitTimeMax: 5
        changeLog:
          createdDateTime: 2024-05-06 16:21:18.545214+00:00
    '415':
      value:
      - errorCode: EQ-3040016
        errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding
        correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec
        additionalInfo:
        - property: contentType
          reason: The payload format is in an unsupported format
    StreamSubscriptionPostRequestExamplePagerduty:
      value:
        type: STREAM_SUBSCRIPTION
        name: pagerduty
        description: subscription-1
        enabled: true
        metricSelector:
          include:
          - equinix.fabric.connection.*
        eventSelector:
          include:
          - equinix.fabric.connection.*
        sink:
          host: https://events.pagerduty.com
          type: PAGERDUTY
          credential:
            type: INTEGRATION_KEY
            integrationKey: my-integration-key
          settings:
            changeUri: https://events.pagerduty.com/v2/change/enqueeue
            alertUri: https://events.pagerduty.com/v2/enqueeue
    StreamSubscriptionPostRequestExampleWebhook:
      value:
        type: STREAM_SUBSCRIPTION
        name: webhook
        description: subscription-1
        enabled: true
        metricSelector:
          include:
          - equinix.fabric.connection.*
        sink:
          type: WEBHOOK
          settings:
            eventUri: https://xxxxxx
            format: CLOUDEVENT
    StreamSubscriptionPostRequestExampleSplunk:
      value:
        type: STREAM_SUBSCRIPTION
        name: splunk1
        description: subscription-1
        enabled: true
        metricSelector:
          include:
          - equinix.fabric.connection.*
        eventSelector:
          include:
          - equinix.fabric.connection.*
        sink:
          uri: https://http-inputs-<host>.splunkcloud.com:<port>/services/collector/event
          type: SPLUNK_HEC
          credential:
            type: ACCESS_TOKEN
            accessToken: Splunk <my-access-token>
          settings:
            source: Equinix
            eventIndex: idx-hec-event
            metricIndex: idx-hec-metric
    StreamSubscriptionPostRequestExampleServicenow:
      value:
        type: STREAM_SUBSCRIPTION
        name: servicenow-1
        description: subscription-1
        enabled: true
        eventSelector:
          include:
          - equinix.fabric.connection.*
        sink:
          host: https://<servicenow-host>.com
          type: SERVICENOW
          credential:
            type: USERNAME_PASSWORD
            username: <servicenow-username>
            password: <servicenow-password>
          settings:
            source: Equinix
    '401':
      value:
      - errorCode: EQ-3000039
        errorMessage: User not found in request or invalid.
        correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515
    '500':
      value:
      - errorCode: EQ-3045004
        errorMessage: Internal Server Error
        correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515
        details: Internal Server Error
  schemas:
    PriceError_additionalInfo:
      type: object
      properties:
        property:
          type: string
        reason:
          type: string
    StreamSubscriptionPutRequest:
      required:
      - name
      - sink
      - type
      type: object
      properties:
        type:
          type: string
          enum:
          - STREAM_SUBSCRIPTION
        name:
          type: string
          description: Customer-provided stream subscription name
        description:
          type: string
          description: Customer-provided stream subscription description
        enabled:
          type: boolean
          description: Stream subscription enabled status
          example: true
        filters:
          $ref: '#/components/schemas/StreamSubscriptionFilter'
        metricSelector:
          $ref: '#/components/schemas/StreamSubscriptionSelector'
        eventSelector:
          $ref: '#/components/schemas/StreamSubscriptionSelector'
        sink:
          $ref: '#/components/schemas/StreamSubscriptionSink'
      description: Update Stream Subscription
    GetAllStreamSubscriptionResponse:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        data:
          type: array
          description: Data returned from the API call.
          items:
            $ref: '#/components/schemas/StreamSubscription'
    StreamSubscriptionOperationErrors:
      type: object
      properties:
        errorCode:
          type: string
          description: Equinix Observability error code
        errorMessage:
          type: string
          description: Equinix Observability error message
        dateTime:
          type: string
          description: Equinix Observability error date time
          format: date-time
        additionalInfo:
          $ref: '#/components/schemas/StreamSubscriptionOperationAdditionalInfo'
      description: Error information for stream subscription delivery
    Error:
      required:
      - errorCode
      - errorMessage
      type: object
      properties:
        errorCode:
          pattern: ^EQ-\d{7}$
          type: string
        errorMessage:
          type: string
        correlationId:
          type: string
        details:
          type: string
        help:
          type: string
        additionalInfo:
          type: array
          items:
            $ref: '#/components/schemas/PriceError_additionalInfo'
      description: Error Response with details
    StreamSubscription:
      type: object
      properties:
        href:
          type: string
          description: Stream Subscription URI
          format: uri
          readOnly: true
          example: https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/subscriptions/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170
        uuid:
          type: string
          description: Equinix-assigned access point identifier
          format: uuid
          example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170
        type:
          type: string
          description: type
          enum:
          - STREAM_SUBSCRIPTION
        name:
          type: string
          description: Customer-provided subscription name
        description:
          type: string
          description: Customer-provided subscription description
        state:
          type: string
          description: Steam subscription provision state
          enum:
          - PROVISIONING
          - PROVISIONED
          - REPROVISIONING
          - DEPROVISIONING
          - DEPROVISIONED
          - FAILED
        enabled:
          type: boolean
          description: Stream subscription enabled status
        metricSelector:
          $ref: '#/components/schemas/StreamSubscriptionSelector'
        eventSelector:
          $ref: '#/components/schemas/StreamSubscriptionSelector'
        sink:
          $ref: '#/components/schemas/StreamSubscriptionSinkResponse'
        operation:
          $ref: '#/components/schemas/StreamSubscriptionOperation'
        changeLog:
          $ref: '#/components/schemas/Changelog'
      description: Stream Subscription object
    ErrorList:
      type: array
      description: List of Error Message
      items:
        $ref: '#/components/schemas/Error'
    StreamSubscriptionSink:
      required:
      - type
      type: object
      properties:
        uri:
          type: string
          description: any publicly reachable http endpoint
        type:
          type: string
          description: destination type
          enum:
          - DATADOG
          - GOOGLE_PUBSUB
          - PAGERDUTY
          - SERVICENOW
          - SLACK
          - SPLUNK_HEC
          - TEAMS
          - WEBHOOK
        batchEnabled:
          type: boolean
          description: batch mode on/off
          example: false
        batchSizeMax:
          type: integer
          description: maximum batch size
        batchWaitTimeMax:
          type: integer
          description: maximum batch waiting time
        credential:
          $ref: '#/components/schemas/StreamSubscriptionSinkCredential'
        settings:
          $ref: '#/components/schemas/StreamSubscriptionSinkSetting'
        host:
          type: string
          description: sink host
      description: Create Stream destination
    Changelog:
      type: object
      properties:
        createdBy:
          type: string
          description: Created by User Key
          example: johnsmith
        createdByFullName:
          type: string
          description: Created by User Full Name
          example: John Smith
        createdByEmail:
          type: string
          description: Created by User Email Address
          example: john.smith@example.com
        createdDateTime:
          type: string
          description: Created by Date and Time
          format: date-time
          example: 2020-11-06 07:00:00+00:00
        updatedBy:
          type: string
          description: Updated by User Key
          example: johnsmith
        updatedByFullName:
          type: string
          description: Updated by User Full Name
          example: John Smith
        updatedByEmail:
          type: string
          description: Updated by User Email Address
          example: john.smith@example.com
        updatedDateTime:
          type: string
          description: Updated by Date and Time
          format: date-time
          example: 2020-11-06 07:00:00+00:00
        deletedBy:
          type: string
          description: Deleted by User Key
          example: johnsmith
        deletedByFullName:
          type: string
          description: Deleted by User Full Name
          example: John Smith
        deletedByEmail:
          type: string
          description: Deleted by User Email Address
          example: john.smith@example.com
        deletedDateTime:
          type: string
          description: Deleted by Date and Time
          format: date-time
          example: 2020-11-06 07:00:00+00:00
      description: Change log
    StreamSubscriptionSelectorExpression:
      type: string
      description: "Supported event or metric types to use on event

# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/equinix/refs/heads/main/openapi/equinix-stream-subscriptions-api-openapi.yml