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

# Create a new cycler for a site

> Create a new cycler under the specified site (by ID).

The request body must include ``project_id`` — the project that will own this
cycler. The site is org-scoped (cross-project), so any of the org's sites may
host a cycler for any of its projects. Returns the created cycler and sets the
Location header.



## OpenAPI

````yaml https://api.ionworks.com/openapi.json post /sites/{site_id}/cyclers
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://api.ionworks.com
    description: Production
security: []
paths:
  /sites/{site_id}/cyclers:
    post:
      tags:
        - Sites
        - Cyclers
      summary: Create a new cycler for a site
      description: >-
        Create a new cycler under the specified site (by ID).


        The request body must include ``project_id`` — the project that will own
        this

        cycler. The site is org-scoped (cross-project), so any of the org's
        sites may

        host a cycler for any of its projects. Returns the created cycler and
        sets the

        Location header.
      operationId: create_cycler_sites__site_id__cyclers_post
      parameters:
        - name: site_id
          in: path
          required: true
          schema:
            type: string
            title: Site Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              title: Raw Data
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cycler'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    Cycler:
      properties:
        name:
          type: string
          title: Name
          description: Name of the cycler
        manufacturer:
          anyOf:
            - type: string
            - type: 'null'
          title: Manufacturer
          description: Manufacturer of the cycler (e.g. Arbin, Maccor)
        model:
          anyOf:
            - type: string
            - type: 'null'
          title: Model
          description: Model of the cycler
        notes:
          anyOf:
            - type: string
            - type: 'null'
          title: Notes
          description: Free-text notes about the cycler
        site_id:
          type: string
          title: Site Id
          description: Foreign key to the parent site
        project_id:
          type: string
          title: Project Id
          description: Project that owns this cycler
        id:
          type: string
          title: Id
          description: Unique identifier for the cycler
        organization_id:
          type: string
          title: Organization Id
          description: Organization this cycler belongs to.
        created_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Created By
          description: User ID of the user who created this cycler
        created_by_email:
          anyOf:
            - type: string
            - type: 'null'
          title: Created By Email
          description: Email of the user who created this cycler
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Timestamp when the cycler was created
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: Timestamp when the cycler was last updated
        channel_ids:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Channel Ids
          description: List of channel IDs belonging to this cycler
      type: object
      required:
        - name
        - site_id
        - project_id
        - id
        - organization_id
        - created_at
        - updated_at
      title: Cycler
      description: Model representing a cycler as returned by the API.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````