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

# Pause a deployed automation



## OpenAPI

````yaml POST /api/automation/deployments/pause
openapi: 3.0.3
info:
  title: arg.ai API
  version: 0.1.0
  description: >-
    The workspace for teams and agents: files, a sandbox to run code in, and
    agents that work in both.


    Authenticate with an API key in the `X-API-Key` header, or a user access
    token in `Authorization: Bearer`. A handful of account-level routes accept a
    user session only; each says so.


    Errors are JSON objects with a `detail` string and the matching HTTP status.
servers:
  - url: https://api.arg.ai
security: []
tags:
  - name: .well-known
    description: Discovery documents for MCP client authorization.
  - name: action-runs
    description: Cross-workspace Action run history.
  - name: actions
    description: Discover and run Actions - the typed capability catalog agents call.
  - name: actions-exec
    description: Token-authenticated Action execution for sandboxes, sites and servers.
  - name: agent
    description: Start agent runs, watch them, steer the queue, and stop them.
  - name: auth
    description: Authenticated user, profile, and session endpoints.
  - name: automation
    description: Deploy, trigger, and inspect automations.
  - name: chats
    description: 'Chat records: list, read, rename, pin, archive, and delete.'
  - name: connectors
    description: Bring-your-own MCP connectors and their credentials.
  - name: file-invitations
    description: file-invitations endpoints.
  - name: files
    description: files endpoints.
  - name: git-repos
    description: git-repos endpoints.
  - name: health
    description: Service health and metadata.
  - name: integrations
    description: Third-party integration connections and their OAuth flows.
  - name: keys
    description: API keys for programmatic access.
  - name: loops
    description: loops endpoints.
  - name: mcp
    description: Model Context Protocol endpoints for MCP clients.
  - name: models
    description: Available models and per-organization model settings.
  - name: notifications
    description: Notifications and delivery preferences.
  - name: oauth
    description: OAuth 2.1 authorization server used by MCP clients.
  - name: organizations
    description: Organizations, members, roles, invitations, and billing.
  - name: service-accounts
    description: Non-human identities that own API keys.
  - name: share
    description: Share links, public file access, and invitations.
  - name: site-access
    description: site-access endpoints.
  - name: sites
    description: Hosted sites built from a workspace folder.
  - name: templates
    description: Publish and clone workspace templates.
  - name: tunnel-access
    description: tunnel-access endpoints.
  - name: tunnels
    description: 'Servers: long-running processes exposed on an HTTPS URL.'
  - name: workspaces
    description: Workspaces, files, tools, search, and workspace-scoped features.
paths:
  /api/automation/deployments/pause:
    post:
      tags:
        - automation
      summary: Pause a deployed automation
      operationId: postApiAutomationDeploymentsPause
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                workspace_id:
                  type: string
                  description: Workspace holding the automation file.
                file_path:
                  type: string
                  description: Deployed `.automation` file or `.arg/workflows` YAML file.
              required:
                - workspace_id
                - file_path
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        default:
          description: Error response
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````