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

# Get Collections

> Get information about all [available collections](/taxii/collection/overview#available-collections) in the API root.

Collections contain the STIX objects you can download from Pulsedive's TAXII server.




## OpenAPI

````yaml /taxii/api.yaml get /taxii2/api/collections
openapi: 3.0.3
info:
  title: Pulsedive TAXII API Reference
  version: 1.0.0
  description: >
    The Pulsedive TAXII endpoint lets you export indicators and threats using
    industry-standard STIX format.


    Please report any discrepancies in API behavior to <a
    href="mailto:support@pulsedive.com">Pulsedive Support</a>.
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  contact:
    email: support@pulsedive.com
servers:
  - url: https://pulsedive.com
security: []
tags:
  - name: API Roots
    description: Get API roots.
  - name: Collections
    description: >-
      Collections contain the STIX objects you can download from Pulsedive's
      TAXII server.
  - name: Objects
    description: >-
      Objects are the individual STIX entities within a collection, such as
      indicators, threat actors, malware, and other intelligence artifacts.
externalDocs:
  url: https://docs.pulsedive.com
paths:
  /taxii2/api/collections:
    get:
      tags:
        - Collections
      summary: Get Collections
      description: >
        Get information about all [available
        collections](/taxii/collection/overview#available-collections) in the
        API root.


        Collections contain the STIX objects you can download from Pulsedive's
        TAXII server.
      operationId: getAllCollections
      parameters:
        - $ref: '#/components/parameters/AcceptHeader'
        - $ref: '#/components/parameters/AcceptQuery'
        - $ref: '#/components/parameters/Pretty'
      responses:
        '200':
          description: Successful request. Returns collection information in JSON format.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - HTTP Basic Authorization: []
        - API Key in Query String: []
      x-codeSamples:
        - lang: curl
          label: Production
          source: |
            curl "https://pulsedive.com/taxii2/api/collections" \
              -H "Accept: application/taxii+json;version=2.1" \
              -u "taxii2:<YOUR_API_KEY>"
        - lang: curl
          label: Testing
          source: >
            curl
            "https://pulsedive.com/taxii2/api/collections?accept=application%2Ftaxii%2Bjson%3Bversion%3D2.1&key=<YOUR_API_KEY>"
components:
  parameters:
    AcceptHeader:
      name: Accept
      in: header
      required: false
      description: >
        Media type used for content negotiation. Use
        `application/taxii+json;version=2.1` for TAXII requests.


        Standard method required by the TAXII specification. Use in production
        environments.
      schema:
        type: string
    AcceptQuery:
      name: accept
      in: query
      required: true
      description: >
        Media type used for content negotiation. Use
        `application/taxii+json;version=2.1` for TAXII requests.


        Specific to Pulsedive's implementation. Best for testing and debugging,
        manual API exploration, and simple curl commands. For production
        deployments, use [HTTP Accept
        Header](/taxii/versioning#http-accept-header).
      schema:
        type: string
    Pretty:
      name: pretty
      in: query
      required: false
      description: |
        Indicates whether to format returned JSON results.

        For pretty-printed output, set to 1.
        For compact output, set to 0.
      schema:
        type: integer
        enum:
          - 0
          - 1
        default: 0
      examples:
        compact:
          summary: Compact output
          value: 0
        pretty:
          summary: Pretty-printed output
          value: 1
  schemas:
    CollectionResponse:
      type: object
      properties:
        collections:
          type: array
          description: Available collections.
          items:
            type: object
            description: Summary information about the collection.
            properties:
              id:
                type: string
                description: |
                  Unique identifier for the collection.
              title:
                type: string
                description: |
                  Name of the collection.
              description:
                type: string
                description: >
                  Description of the collection's contents and access
                  requirements.
              can_read:
                type: boolean
                description: >
                  Indicates whether your current plan allows reading from this
                  collection.
              can_write:
                type: boolean
                description: >
                  Indicates whether you can write to this collection. Always
                  `false` for Pulsedive collections.
              media_types:
                type: array
                description: >
                  Array of supported media types. Always includes
                  `application/stix+json;version=2.1`.
                items:
                  type: string
      example:
        collections:
          - id: a5cffbfe-c0ff-4842-a235-cb3a7a040a37
            title: Pulsedive indicator data
            description: >-
              This collection includes all of Pulsedive's indicators. Access is
              granted to Pulsedive Pro and Feed customers. Filters may be
              restricted depending on your tier. See our product pages for more
              information: pulsedive.com/about
            can_read: false
            can_write: false
            media_types:
              - application/stix+json;version=2.1
          - id: dc9ecfa5-7769-4cf3-b699-38a9776b431d
            title: Pulsedive threat data
            description: >-
              This collection includes all of Pulsedive's data on threats.
              Access is granted to Pulsedive Pro, API, and Feed customers. See
              our product pages to learn more: pulsedive.com/about
            can_read: false
            can_write: false
            media_types:
              - application/stix+json;version=2.1
          - id: 981c4916-ebb2-4567-aece-54ae970c4230
            title: Pulsedive test data
            description: This collection includes live indicator data for testing.
            can_read: true
            can_write: false
            media_types:
              - application/stix+json;version=2.1
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Message describing the error that occurred, if available.
  responses:
    BadRequest:
      description: |
        Bad request. The request was malformed or missing required parameters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: |
        Unauthorized. Your API key is missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: |
        Not found. The requested indicator could not be located.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    TooManyRequests:
      description: >
        Rate limit exceeded. Too many requests have been made in a short period
        of time.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalServerError:
      description: |
        Server error. An unexpected problem occurred on our end.
        These errors are automatically reported to our team.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    HTTP Basic Authorization:
      type: http
      scheme: basic
      description: >
        Encode your credentials in the format `taxii2:<YOUR_API_KEY>` using
        Base64 and include them in the `Authorization` header. An API key is
        required for all requests.


        Some tools require a username and password separately. Use `taxii2` as
        the username and your API key as the password. The client will
        automatically encode this as `taxii2:<YOUR_API_KEY>` and convert to
        Base64.


        If using **Try It**: Use the username/password method for HTTP Basic
        Authorization.
    API Key in Query String:
      type: apiKey
      in: query
      name: key
      description: >
        Include your API key as a query parameter. An API key is required for
        all requests.


        Specific to Pulsedive's implementation. Best for testing and debugging,
        manual API exploration, and simple curl commands. For production, use
        [HTTP Basic
        Authorization](/taxii/authentication#http-basic-authorization).

````