Armis

Armis Sites API

The Sites API from Armis — 2 operation(s) for sites.

GitHub OpenAPI

Operations 5

POST /settings/sites Create a new site #
GET /settings/sites List sites #
DELETE /settings/sites/{site_id} Delete a site #
GET /settings/sites/{site_id} Get a site #
PATCH /settings/sites/{site_id} Update a site #

Documentation

📖
Documentation
https://dev.armis.com/docs/your-guide-to-building-with-armis-apis
📖
APIReference
https://dev.armis.com/reference
📖
Authentication
https://dev.armis.com/docs/authentication
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/armis/refs/heads/main/rate-limits/armis-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/armis/refs/heads/main/openapi/armis-sites-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/armis/refs/heads/main/json-schema/armis-persistent-alert-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/armis/refs/heads/main/json-schema/armis-persistent-collector-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/armis/refs/heads/main/json-schema/armis-search-assets-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/armis/refs/heads/main/json-schema/armis-persistent-integration-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/armis/refs/heads/main/json-schema/armis-persistent-site-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/armis/refs/heads/main/json-schema/armis-auth-request-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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/armis:armis-sites-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

armis-sites-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Armis API v3 Sites API
  version: 0.13.0
servers:
- url: https://api.armis.com/v3
tags:
- name: Sites
paths:
  /settings/sites:
    post:
      tags:
      - Sites
      summary: Create a new site
      description: '### Required scopes:

        * `PERMISSION.SETTINGS.SITES_AND_SENSORS.MANAGE.SITES`'
      operationId: post_settings_sites_post
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SiteCreateRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PersistentSite'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Sites
      summary: List sites
      description: '### Required scopes:

        * `PERMISSION.SETTINGS.SITES_AND_SENSORS.READ`'
      operationId: get_settings_sites_get
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: After
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          default: 10
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PersistentSiteItems'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /settings/sites/{site_id}:
    delete:
      tags:
      - Sites
      summary: Delete a site
      description: '### Required scopes:

        * `PERMISSION.SETTINGS.SITES_AND_SENSORS.MANAGE.SITES`'
      operationId: delete_settings_sites__site_id__delete
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: site_id
        in: path
        required: true
        schema:
          type: integer
          title: Site Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Sites
      summary: Get a site
      description: '### Required scopes:

        * `PERMISSION.SETTINGS.SITES_AND_SENSORS.READ`'
      operationId: get_settings_sites__site_id__get
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: site_id
        in: path
        required: true
        schema:
          type: integer
          title: Site Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PersistentSite'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - Sites
      summary: Update a site
      description: '### Required scopes:

        * `PERMISSION.SETTINGS.SITES_AND_SENSORS.MANAGE.SITES`'
      operationId: patch_settings_sites__site_id__patch
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: site_id
        in: path
        required: true
        schema:
          type: integer
          title: Site Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SiteUpdateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PersistentSite'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    AsqRule:
      anyOf:
      - $ref: '#/components/schemas/AndRule'
      - $ref: '#/components/schemas/OrRule'
      title: AsqRule
      examples:
      - and:
        - category:Computers
        - model:Mac
      - or:
        - category:Computers
        - model:iPhone
      - and:
        - category:Computers
        - or:
          - category:Computers
          - model:iPhone
    SiteUpdateRequest:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          description: Site name
          examples:
          - San Francisco HQ
        location:
          anyOf:
          - type: string
          - type: 'null'
          title: Location
          description: The name of the location of the site, such as an address. When this field is set, the `lat` and `lng` are automatically derived from it.
          examples:
          - 548 Market Street Suite 97439 San Francisco, CA 94104-5401
        parent_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Parent Id
        tier:
          anyOf:
          - type: string
          - type: 'null'
          title: Tier
        asq_rule:
          anyOf:
          - $ref: '#/components/schemas/AsqRule'
          - type: 'null'
          description: Devices matching this ASQ rule will be associated with this site.
          examples:
          - and:
            - category:Computers
        asq_rule_description:
          anyOf:
          - type: string
          - type: 'null'
          title: Asq Rule Description
        network_equipment_device_ids:
          anyOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: Network Equipment Device Ids
          description: Devices that are detected through these network equipment devices will be associated with this site.
          examples:
          - - 1
            - 2
            - 3
        integration_ids:
          anyOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: Integration Ids
          description: Devices that are detected through these integration will be associated with this site.
          examples:
          - - 4
            - 5
            - 6
      type: object
      title: SiteUpdateRequest
      examples:
      - asq_rule:
          and:
          - category:Computers
        integration_ids:
        - 4
        - 5
        - 6
        location: 548 Market Street Suite 97439 San Francisco, CA 94104-5401
        name: San Francisco HQ
        network_equipment_device_ids:
        - 1
        - 2
        - 3
    OrRule:
      properties:
        and:
          items:
            anyOf:
            - type: string
            - type: object
              description: Another AsqRule
          type: array
          title: And
      type: object
      required:
      - or
      title: OrRule
    PersistentSiteItems:
      properties:
        items:
          items:
            $ref: '#/components/schemas/PersistentSite'
          type: array
          title: Items
        next:
          anyOf:
          - type: string
          - type: 'null'
          title: Next
      type: object
      required:
      - items
      title: PersistentSiteItems
      examples:
      - items:
        - asq_rule:
            and:
            - category:Computers
          id: 1
          integration_ids:
          - 4
          - 5
          - 6
          lat: 37.79
          lng: -122.4
          location: 548 Market Street Suite 97439 San Francisco, CA 94104-5401
          name: San Francisco HQ
          network_equipment_device_ids:
          - 1
          - 2
          - 3
        next: F3xsEf
    AndRule:
      properties:
        or:
          items:
            anyOf:
            - type: string
            - type: object
              description: Another AsqRule
          type: array
          title: Or
      type: object
      required:
      - and
      title: AndRule
    PersistentSite:
      properties:
        name:
          type: string
          title: Name
        location:
          anyOf:
          - type: string
          - type: 'null'
          title: Location
          description: The name of the location of the site, such as an address. When this field is set, the `lat` and `lng` are automatically derived from it.
          examples:
          - 548 Market Street Suite 97439 San Francisco, CA 94104-5401
        parent_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Parent Id
        tier:
          anyOf:
          - type: string
          - type: 'null'
          title: Tier
        asq_rule:
          anyOf:
          - $ref: '#/components/schemas/AsqRule'
          - type: 'null'
          description: Devices matching this ASQ rule will be associated with this site.
          examples:
          - and:
            - category:Computers
        asq_rule_description:
          anyOf:
          - type: string
          - type: 'null'
          title: Asq Rule Description
        network_equipment_device_ids:
          anyOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: Network Equipment Device Ids
          description: Devices that are detected through these network equipment devices will be associated with this site.
          examples:
          - - 1
            - 2
            - 3
        integration_ids:
          anyOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: Integration Ids
          description: Devices that are detected through these integration will be associated with this site.
          examples:
          - - 4
            - 5
            - 6
        id:
          type: integer
          title: Id
        lat:
          anyOf:
          - type: number
          - type: 'null'
          title: Latitude
          description: The latitude coordinate of the physical location of the site on earth. This field is read-only and is automatically derived from the `location` field.
          examples:
          - 37.79
        lng:
          anyOf:
          - type: number
          - type: 'null'
          title: Longitude
          description: The longitude coordinate of the physical location of the site on earth. This field is read-only and is automatically derived from the `location` field.
          examples:
          - -122.4
      type: object
      required:
      - name
      - id
      title: PersistentSite
      examples:
      - asq_rule:
          and:
          - category:Computers
        id: 1
        integration_ids:
        - 4
        - 5
        - 6
        lat: 37.79
        lng: -122.4
        location: 548 Market Street Suite 97439 San Francisco, CA 94104-5401
        name: San Francisco HQ
        network_equipment_device_ids:
        - 1
        - 2
        - 3
    SiteCreateRequest:
      properties:
        name:
          type: string
          title: Name
        location:
          anyOf:
          - type: string
          - type: 'null'
          title: Location
          description: The name of the location of the site, such as an address. When this field is set, the `lat` and `lng` are automatically derived from it.
          examples:
          - 548 Market Street Suite 97439 San Francisco, CA 94104-5401
        parent_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Parent Id
        tier:
          anyOf:
          - type: string
          - type: 'null'
          title: Tier
        asq_rule:
          anyOf:
          - $ref: '#/components/schemas/AsqRule'
          - type: 'null'
          description: Devices matching this ASQ rule will be associated with this site.
          examples:
          - and:
            - category:Computers
        asq_rule_description:
          anyOf:
          - type: string
          - type: 'null'
          title: Asq Rule Description
        network_equipment_device_ids:
          anyOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: Network Equipment Device Ids
          description: Devices that are detected through these network equipment devices will be associated with this site.
          examples:
          - - 1
            - 2
            - 3
        integration_ids:
          anyOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: Integration Ids
          description: Devices that are detected through these integration will be associated with this site.
          examples:
          - - 4
            - 5
            - 6
      type: object
      required:
      - name
      title: SiteCreateRequest
      examples:
      - asq_rule:
          and:
          - category:Computers
        integration_ids:
        - 4
        - 5
        - 6
        location: 548 Market Street Suite 97439 San Francisco, CA 94104-5401
        name: San Francisco HQ
        network_equipment_device_ids:
        - 1
        - 2
        - 3
    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
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-Armis-Client-Name
x-provenance:
  method: searched
  source: https://dev.armis.com/reference
  harvested: '2026-10-20'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://dev.armis.com/reference/delete_settings_boundaries__boundary_id__delete.md
  - https://dev.armis.com/reference/delete_settings_device_custom_properties__config_id__delete.md
  - https://dev.armis.com/reference/delete_settings_integrations__integration_id__delete.md
  - https://dev.armis.com/reference/delete_settings_sites__site_id__delete.md
  - https://dev.armis.com/reference/enable_data_export__entity___enable_post.md
  - https://dev.armis.com/reference/fields_assets__search_fields_get.md
  - https://dev.armis.com/reference/get_alerts__alert_id__get.md
  - https://dev.armis.com/reference/get_collectors__collector_number__get.md
  - https://dev.armis.com/reference/get_collectors__image_get.md
  - https://dev.armis.com/reference/get_collectors_get.md
  - https://dev.armis.com/reference/get_data_export__entity__get.md
  - https://dev.armis.com/reference/get_policies_get.md
  - https://dev.armis.com/reference/get_settings_boundaries__boundary_id__get.md
  - https://dev.armis.com/reference/get_settings_boundaries_get.md
  - https://dev.armis.com/reference/get_settings_device_custom_properties__config_id__get.md
  - https://dev.armis.com/reference/get_settings_device_custom_properties_get.md
  - https://dev.armis.com/reference/get_settings_integrations__integration_id__get.md
  - https://dev.armis.com/reference/get_settings_integrations_get.md
  - https://dev.armis.com/reference/get_settings_sites__site_id__get.md
  - https://dev.armis.com/reference/get_settings_sites_get.md
  - https://dev.armis.com/reference/patch_settings_boundaries__boundary_id__patch.md
  - https://dev.armis.com/reference/patch_settings_device_custom_properties__config_id__patch.md
  - https://dev.armis.com/reference/patch_settings_integrations__integration_id__patch.md
  - https://dev.armis.com/reference/patch_settings_sites__site_id__patch.md
  - https://dev.armis.com/reference/post_arps_post.md
  - https://dev.armis.com/reference/post_assets__bulk_post.md
  - https://dev.armis.com/reference/post_oauth_token_post.md
  - https://dev.armis.com/reference/post_settings_boundaries_post.md
  - https://dev.armis.com/reference/post_settings_device_custom_properties_post.md
  - https://dev.armis.com/reference/post_settings_integrations_post.md
  - https://dev.armis.com/reference/post_settings_sites_post.md
  - https://dev.armis.com/reference/search_assets__search_post.md
  - https://dev.armis.com/reference/search_settings_integrations__search_post.md
  - https://dev.armis.com/reference/toggle_data_export__entity__patch.md
  merge:
    pages: 34
    deduped: 206
    conflicts_kept_first: 0