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/demisto-automation-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:
  description: This is the public REST API to integrate with the demisto server.
  title: Demisto Automation API
  version: 2.0.0
servers:
- url: https://hostname:443
security:
- api_key: []
- csrf_token: []
- x-xdr-auth-id: []
tags:
- name: Automation
paths:
  /automation:
    post:
      description: Create or update a given automation.
      summary: Create or update automation
      operationId: saveOrUpdateScript
      responses:
        '200':
          description: The saved automation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/automationScriptResult'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/automationScriptFilterWrapper'
          application/xml:
            schema:
              $ref: '#/components/schemas/automationScriptFilterWrapper'
      tags:
      - Automation
  /automation/copy:
    post:
      description: Copy given automation
      summary: Copy automation
      operationId: copyScript
      responses:
        '200':
          description: The saved automation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/automationScriptResult'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/automationScriptFilterWrapper'
          application/xml:
            schema:
              $ref: '#/components/schemas/automationScriptFilterWrapper'
      tags:
      - Automation
  /automation/delete:
    post:
      description: Delete a given automation from the system.
      summary: Delete existing automation
      operationId: deleteAutomationScript
      responses:
        '200':
          description: automation deleted
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/automationScriptFilterWrapper'
          application/xml:
            schema:
              $ref: '#/components/schemas/automationScriptFilterWrapper'
      tags:
      - Automation
  /automation/import:
    post:
      description: Upload an automation to Cortex XSOAR
      summary: Upload an automation
      operationId: importScript
      responses:
        '200':
          description: The saved automation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationScript'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: file
                  format: binary
              required:
              - file
      tags:
      - Automation
  /automation/search:
    post:
      description: Search Automation by filter
      summary: Search Automation (aka scripts)
      operationId: getAutomationScripts
      responses:
        '200':
          description: automationScriptResult
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/automationScriptResult'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/automationScriptFilter'
          application/xml:
            schema:
              $ref: '#/components/schemas/automationScriptFilter'
      tags:
      - Automation
components:
  schemas:
    ScriptType:
      description: ScriptType holds the type of a script
      type: string
      x-go-package: github.com/demisto/server/domain
    Argument:
      description: Argument to a module command
      type: object
      properties:
        auto:
          type: string
          x-go-name: Auto
        default:
          type: boolean
          x-go-name: Default
        defaultValue:
          type: string
          x-go-name: DefaultValue
        deprecated:
          type: boolean
          x-go-name: Deprecated
        description:
          type: string
          x-go-name: Description
        isArray:
          type: boolean
          x-go-name: IsArray
        name:
          type: string
          x-go-name: Name
        predefined:
          type: array
          items:
            type: string
          x-go-name: Predefined
        required:
          type: boolean
          x-go-name: Required
        secret:
          type: boolean
          x-go-name: Secret
      x-go-package: github.com/demisto/server/domain
    automationScriptFilterWrapper:
      type: object
      title: automationScriptFilterWrapper ...
      properties:
        filter:
          $ref: '#/components/schemas/GenericStringFilter'
        savePassword:
          type: boolean
          x-go-name: StorePassword
        script:
          $ref: '#/components/schemas/AutomationScript'
      x-go-package: github.com/demisto/server/web
    ScriptTarget:
      description: ScriptTarget represents the module where this script should run
      type: integer
      format: int64
      x-go-package: github.com/demisto/server/domain
    automationScriptResult:
      type: object
      title: automationScriptResult ...
      properties:
        pythonEnabled:
          type: boolean
          x-go-name: PythonEnabled
        scripts:
          type: array
          items:
            $ref: '#/components/schemas/AutomationScriptAPI'
          x-go-name: Scripts
        selectedScript:
          type: object
          additionalProperties:
            type: object
          x-go-name: SelectedScript
        suggestions:
          type: array
          items:
            type: string
          x-go-name: Tags
      x-go-package: github.com/demisto/server/web
    Duration:
      description: 'A Duration represents the elapsed time between two instants

        as an int64 nanosecond count. The representation limits the

        largest representable duration to approximately 290 years.'
      type: integer
      format: int64
      x-go-package: time
    Order:
      description: Order struct holds a sort field and the direction of sorting
      type: object
      properties:
        asc:
          type: boolean
          x-go-name: Asc
        field:
          type: string
          x-go-name: Field
        fieldType:
          type: string
          x-go-name: FieldType
      x-go-package: github.com/demisto/server/domain
    automationScriptFilter:
      description: automationScriptFilter is a general filter that fetches entities using a query string query using the Query value
      type: object
      properties:
        Cache:
          description: Cache of join functions
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        page:
          description: 0-based page
          type: integer
          format: int64
          x-go-name: Page
        query:
          type: string
          x-go-name: Query
        searchAfter:
          description: Efficient next page, pass max sort value from previous page
          type: array
          items:
            type: string
          x-go-name: SearchAfter
        searchBefore:
          description: Efficient prev page, pass min sort value from next page
          type: array
          items:
            type: string
          x-go-name: SearchBefore
        size:
          description: Size is limited to 1000, if not passed it defaults to 0, and no results will return
          type: integer
          format: int64
          x-go-name: Size
        sort:
          description: The sort order
          type: array
          items:
            $ref: '#/components/schemas/Order'
          x-go-name: Sort
        stripContext:
          type: boolean
          x-go-name: StripContext
      x-go-package: github.com/demisto/server/web
    Important:
      description: Important The important outputs of a given command
      type: object
      properties:
        contextPath:
          type: string
          x-go-name: ContextPath
        description:
          description: Description is either a string or a map from string to interface
          type: string
          x-go-name: Description
        related:
          description: To what other context path this output is related
          type: string
          x-go-name: Related
      x-go-package: github.com/demisto/server/domain
    Output:
      description: Output of a module command
      type: object
      properties:
        contentPath:
          type: string
          x-go-name: ContentPath
        contextPath:
          type: string
          x-go-name: ContextPath
        description:
          description: Description is either a string or a map from string to interface
          type: object
          x-go-name: Description
        type:
          $ref: '#/components/schemas/OutputType'
      x-go-package: github.com/demisto/server/domain
    AutomationScriptAPI:
      type: object
      title: AutomationScriptAPI ...
      properties:
        arguments:
          type: array
          items:
            $ref: '#/components/schemas/Argument'
          x-go-name: Args
        comment:
          type: string
          x-go-name: Comment
        contextKeys:
          type: array
          items:
            type: string
          x-go-name: ContextKeys
        dependsOn:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          x-go-name: DependsOn
        deprecated:
          type: boolean
          x-go-name: Deprecated
        dockerImage:
          type: string
          x-go-name: DockerImage
        enabled:
          type: boolean
          x-go-name: Enabled
        hidden:
          type: boolean
          x-go-name: Hidden
        id:
          type: string
          x-go-name: ID
        locked:
          type: boolean
          x-go-name: Locked
        modified:
          type: string
          format: date-time
          x-go-name: Modified
        name:
          type: string
          x-go-name: Name
        outputs:
          type: array
          items:
            $ref: '#/components/schemas/Output'
          x-go-name: Outputs
        permitted:
          type: boolean
          x-go-name: Permitted
        roles:
          type: array
          items:
            type: string
          x-go-name: Roles
        runAs:
          type: string
          x-go-name: RunAs
        scriptTarget:
          $ref: '#/components/schemas/ScriptTarget'
        system:
          type: boolean
          x-go-name: System
        tags:
          type: array
          items:
            type: string
          x-go-name: Tags
        type:
          $ref: '#/components/schemas/ScriptType'
        user:
          type: string
          x-go-name: User
        version:
          type: integer
          format: int64
          x-go-name: Version
      x-go-package: github.com/demisto/server/services
    AutomationScript:
      description: AutomationScript represents a script that will run on  the system
      type: object
      properties:
        arguments:
          type: array
          items:
            $ref: '#/components/schemas/Argument'
          x-go-name: Args
        comment:
          type: string
          x-go-name: Comment
        commitMessage:
          type: string
          x-go-name: CommitMessage
        contextKeys:
          type: array
          items:
            type: string
          x-go-name: ContextKeys
        dependsOn:
          description: This fields indicates which commands this script depends on
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          x-go-name: DependsOn
        deprecated:
          type: boolean
          x-go-name: Deprecated
        dockerImage:
          type: string
          x-go-name: DockerImage
        enabled:
          type: boolean
          x-go-name: Enabled
        hasRole:
          description: Internal field to make queries on role faster
          type: boolean
          x-go-name: HasRole
        hidden:
          type: boolean
          x-go-name: Hidden
        id:
          type: string
          x-go-name: ID
        important:
          type: array
          items:
            $ref: '#/components/schemas/Important'
          x-go-name: Important
        locked:
          type: boolean
          x-go-name: Locked
        modified:
          type: string
          format: date-time
          x-go-name: Modified
        name:
          type: string
          x-go-name: Name
        outputs:
          type: array
          items:
            $ref: '#/components/schemas/Output'
          x-go-name: Outputs
        prevName:
          type: string
          x-go-name: PrevName
        previousRoles:
          description: PreviousRoleName - do not change this field manually
          type: array
          items:
            type: string
          x-go-name: PreviousRoleName
        pswd:
          type: string
          x-go-name: Password
        rawTags:
          type: array
          items:
            type: string
          x-go-name: RawTags
        roles:
          description: The role assigned to this investigation
          type: array
          items:
            type: string
          x-go-name: RoleName
        runAs:
          type: string
          x-go-name: RunAs
        runOnce:
          type: boolean
          x-go-name: RunOnce
        script:
          type: string
          x-go-name: Script
        scriptTarget:
          $ref: '#/components/schemas/ScriptTarget'
        searchableName:
          type: string
          x-go-name: DoNotUseName
        sensitive:
          type: boolean
          x-go-name: Sensitive
        shouldCommit:
          type: boolean
          x-go-name: ShouldCommit
        sortValues:
          type: array
          items:
            type: string
          x-go-name: SortValues
        subtype:
          $ref: '#/components/schemas/ScriptSubType'
        system:
          type: boolean
          x-go-name: System
        tags:
          type: array
          items:
            type: string
          x-go-name: Tags
        timeout:
          $ref: '#/components/schemas/Duration'
        type:
          $ref: '#/components/schemas/ScriptType'
        user:
          type: string
          x-go-name: User
        vcShouldIgnore:
          type: boolean
          x-go-name: VCShouldIgnore
        version:
          type: integer
          format: int64
          x-go-name: Versn
        visualScript:
          type: string
          x-go-name: VisualScript
      x-go-package: github.com/demisto/server/domain
    GenericStringFilter:
      description: GenericStringFilter is a general filter that will fetch entities using the Query value
      type: object
      properties:
        Cache:
          description: Cache of join functions
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        page:
          description: 0-based page
          type: integer
          format: int64
          x-go-name: Page
        query:
          type: string
          x-go-name: Query
        searchAfter:
          description: Efficient next page, pass max sort value from previous page
          type: array
          items:
            type: string
          x-go-name: SearchAfter
        searchBefore:
          description: Efficient prev page, pass min sort value from next page
          type: array
          items:
            type: string
          x-go-name: SearchBefore
        size:
          description: Size is limited to 1000, if not passed it defaults to 0, and no results will return
          type: integer
          format: int64
          x-go-name: Size
        sort:
          description: The sort order
          type: array
          items:
            $ref: '#/components/schemas/Order'
          x-go-name: Sort
      x-go-package: github.com/demisto/server/repo/entities
    ScriptSubType:
      description: ScriptSubType holds the script type version
      type: string
      x-go-package: github.com/demisto/server/domain
    OutputType:
      type: string
      title: OutputType ...
      x-go-package: github.com/demisto/server/domain
  securitySchemes:
    api_key:
      type: apiKey
      name: Authorization
      in: header
    csrf_token:
      type: apiKey
      name: X-XSRF-TOKEN
      in: header
    x-xdr-auth-id:
      type: apiKey
      name: x-xdr-auth-id
      in: header