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

# Search Clusters

> Search clusters by name or description.



## OpenAPI

````yaml /integrateio-openapi.yaml get /clusters/search
openapi: 3.0.3
info:
  title: Integrate.io (Xplenty) ETL API
  description: >
    The Integrate.io ETL API (formerly Xplenty) provides functions for
    controlling and monitoring

    clusters, jobs, packages, schedules, deliveries, connections, and account
    management.


    After defining a data processing package using the Integrate.io web
    application, you can call

    this API to create clusters, run jobs, monitor their progress, and terminate
    jobs and clusters.


    ## Authentication

    All API calls require your API key via HTTP Basic Authentication.

    Enter your API key as the **username** and leave the **password** blank.

    ```

    curl -u YOUR_API_KEY: https://api.xplenty.com/{account_id}/api/clusters

    ```


    ## API Versioning

    All requests must include the `Accept` header with the API version:

    ```

    Accept: application/vnd.xplenty+json; version=2

    ```

    Without this header, requests may be routed incorrectly and return `404`
    errors.


    ## Pagination

    Collection endpoints support `offset` and `limit` query parameters.

    Pagination info is provided via the `Link` header (RFC 5988).


    ## Rate Limits

    Each user is allocated 5,000 credits per hour. Most API calls cost 1 credit.

    Exceeding the limit returns a `429 Too Many Requests` response.
  version: '2.0'
  contact:
    name: Integrate.io Support
    url: https://www.integrate.io
  license:
    name: Proprietary
servers:
  - url: https://api.xplenty.com/{account_id}/api
    description: Production API
    variables:
      account_id:
        description: Your Integrate.io (Xplenty) account ID
        default: my-account
security:
  - apiKeyAuth: []
tags:
  - name: Clusters
    description: Create, manage, monitor, and terminate compute clusters
  - name: Jobs
    description: Run, monitor, and manage data processing jobs
  - name: Packages
    description: Manage data flow packages
  - name: Package Validations
    description: Validate package configurations
  - name: Schedules
    description: Create and manage recurring job schedules
  - name: Deliveries
    description: Manage data delivery blueprints
  - name: Connections
    description: Manage data source and destination connections
  - name: Accounts
    description: Manage Integrate.io accounts
  - name: Members
    description: Manage account members and roles
  - name: Users
    description: Manage authenticated user information
  - name: Public Keys
    description: Manage SSH public keys
  - name: Notifications
    description: View and manage user notifications
  - name: Hooks
    description: Manage webhooks for event notifications
  - name: System
    description: System information (regions, stacks, time zones, variables)
  - name: Billing
    description: Subscription, invoices, and payment methods
paths:
  /clusters/search:
    get:
      tags:
        - Clusters
      summary: Search Clusters
      description: Search clusters by name or description.
      operationId: searchClusters
      parameters:
        - $ref: '#/components/parameters/acceptHeader'
        - name: q
          in: query
          required: true
          description: Search query string
          schema:
            type: string
        - $ref: '#/components/parameters/offsetParam'
        - $ref: '#/components/parameters/limitParam'
      responses:
        '200':
          description: Successful response
          content:
            application/vnd.xplenty+json; version=2:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Cluster'
components:
  parameters:
    acceptHeader:
      name: Accept
      in: header
      required: true
      description: API version header — required on all requests
      schema:
        type: string
        default: application/vnd.xplenty+json; version=2
    offsetParam:
      name: offset
      in: query
      description: Index of the first object to retrieve (starting from 0)
      schema:
        type: integer
        minimum: 0
        default: 0
    limitParam:
      name: limit
      in: query
      description: Number of items to return (max 100)
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
  schemas:
    Cluster:
      type: object
      properties:
        id:
          type: integer
          example: 99
        name:
          type: string
          example: 'Daily Outliers Test #100'
        description:
          type: string
          example: Daily Outliers Test
        status:
          type: string
          enum:
            - pending
            - creating
            - available
            - scaling
            - pending_terminate
            - terminating
            - terminated
            - error
          example: available
        owner_id:
          type: integer
          example: 27
        plan_id:
          type: integer
          nullable: true
        nodes:
          type: integer
          example: 2
        type:
          type: string
          enum:
            - sandbox
            - production
          example: production
        created_at:
          type: string
          format: date-time
          example: '2013-01-25T08:18:39Z'
        updated_at:
          type: string
          format: date-time
          example: '2013-01-28T16:45:24Z'
        available_since:
          type: string
          format: date-time
          nullable: true
        terminated_at:
          type: string
          format: date-time
          nullable: true
        running_jobs_count:
          type: integer
          example: 0
        terminate_on_idle:
          type: boolean
          example: false
        time_to_idle:
          type: integer
          description: Seconds of inactivity before auto-termination
          example: 3600
        terminated_on_idle:
          type: boolean
          example: false
        region:
          type: string
          example: amazon-web-services::us-east-1
        zone:
          type: string
          example: us-east-1b
        master_instance_type:
          type: string
          example: m3.xlarge
        slave_instance_type:
          type: string
          example: m3.xlarge
        master_spot_price:
          type: number
          nullable: true
        slave_spot_price:
          type: number
          nullable: true
        master_spot_percentage:
          type: number
          nullable: true
        slave_spot_percentage:
          type: number
          nullable: true
        allow_fallback:
          type: boolean
          example: true
        stack:
          type: string
          example: white-everest
        idle_since:
          type: string
          format: date-time
          nullable: true
        url:
          type: string
          format: uri
          example: https://api.xplenty.com/xplenation/api/clusters/99
        html_url:
          type: string
          format: uri
          example: https://xplenty.com/xplenation/clusters/99
        creator:
          type: object
          properties:
            type:
              type: string
            display_name:
              type: string
            id:
              type: integer
            url:
              type: string
              format: uri
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: basic
      description: |
        Enter your API key as the username. Leave the password field blank.
        Example: `curl -u YOUR_API_KEY: https://api.xplenty.com/...`

````