Armis

Armis Device Custom Properties API

The Device Custom Properties API from Armis — 2 operation(s) for device custom properties.

GitHub OpenAPI

Operations 5

POST /settings/device-custom-properties Create a new device custom property configuration #
GET /settings/device-custom-properties List all device custom property configurations #
DELETE /settings/device-custom-properties/{config_id} Delete a device custom property configuration #
GET /settings/device-custom-properties/{config_id} Get a device custom property configuration #
PATCH /settings/device-custom-properties/{config_id} Update a device custom property configuration #

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-device-custom-properties-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-device-custom-properties-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-device-custom-properties-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Armis API v3 Device Custom Properties API
  version: 0.13.0
servers:
- url: https://api.armis.com/v3
tags:
- name: Device Custom Properties
paths:
  /settings/device-custom-properties:
    post:
      tags:
      - Device Custom Properties
      summary: Create a new device custom property configuration
      description: '### Required scopes:

        * `PERMISSION.SETTINGS.CUSTOM_PROPERTIES.MANAGE`'
      operationId: post_settings_device_custom_properties_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Config'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PersistentConfig'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
    get:
      tags:
      - Device Custom Properties
      summary: List all device custom property configurations
      description: '### Required scopes:

        * `PERMISSION.SETTINGS.CUSTOM_PROPERTIES.READ`'
      operationId: get_settings_device_custom_properties_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PersistentConfigItems'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /settings/device-custom-properties/{config_id}:
    delete:
      tags:
      - Device Custom Properties
      summary: Delete a device custom property configuration
      description: '### Required scopes:

        * `PERMISSION.SETTINGS.CUSTOM_PROPERTIES.MANAGE`'
      operationId: delete_settings_device_custom_properties__config_id__delete
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: config_id
        in: path
        required: true
        schema:
          type: integer
          title: Config Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Device Custom Properties
      summary: Get a device custom property configuration
      description: '### Required scopes:

        * `PERMISSION.SETTINGS.CUSTOM_PROPERTIES.READ`'
      operationId: get_settings_device_custom_properties__config_id__get
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: config_id
        in: path
        required: true
        schema:
          type: integer
          title: Config Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PersistentConfig'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - Device Custom Properties
      summary: Update a device custom property configuration
      description: '### Required scopes:

        * `PERMISSION.SETTINGS.CUSTOM_PROPERTIES.MANAGE`'
      operationId: patch_settings_device_custom_properties__config_id__patch
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: config_id
        in: path
        required: true
        schema:
          type: integer
          title: Config Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PartialConfigRequest'
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PersistentConfig:
      properties:
        name:
          type: string
          maxLength: 40
          pattern: ^[\w_]*$
          title: Name
        description:
          anyOf:
          - type: string
            maxLength: 250
          - type: 'null'
          title: Description
        type:
          type: string
          enum:
          - boolean
          - enum
          - externalLink
          - integer
          - string
          - timestamp
          title: Type
        allowed_values:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Allowed Values
        id:
          type: integer
          title: Id
        created_by:
          type: string
          title: Created By
        creation_time:
          type: string
          format: date-time
          title: Creation Time
      type: object
      required:
      - name
      - type
      - id
      - created_by
      - creation_time
      title: PersistentConfig
      examples:
      - allowed_values:
        - Small
        - Medium
        - Large
        created_by: user@acme.com
        creation_time: '2025-06-16T00:00:00Z'
        description: The size of the device.
        id: 1
        name: Size
        type: enum
    Config:
      properties:
        name:
          type: string
          maxLength: 40
          pattern: ^[\w_]*$
          title: Name
        description:
          anyOf:
          - type: string
            maxLength: 250
          - type: 'null'
          title: Description
        type:
          type: string
          enum:
          - boolean
          - enum
          - externalLink
          - integer
          - string
          - timestamp
          title: Type
        allowed_values:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Allowed Values
      type: object
      required:
      - name
      - type
      title: Config
      examples:
      - allowed_values:
        - Small
        - Medium
        - Large
        description: The size of the device.
        name: Size
        type: enum
      - description: The year the device was built.
        name: BuildYear
        type: integer
    PersistentConfigItems:
      properties:
        items:
          items:
            $ref: '#/components/schemas/PersistentConfig'
          type: array
          title: Items
      type: object
      required:
      - items
      title: PersistentConfigItems
      examples:
      - items:
        - allowed_values:
          - Small
          - Medium
          - Large
          created_by: user@acme.com
          creation_time: '2025-06-16T00:00:00Z'
          description: The size of the device.
          id: 1
          name: Size
          type: enum
        - created_by: user@acme.com
          creation_time: '2025-06-16T00:00:00Z'
          description: The year the device was built.
          id: 2
          name: BuildYear
          type: integer
    PartialConfigRequest:
      properties:
        description:
          anyOf:
          - type: string
            maxLength: 250
          - type: 'null'
          title: Description
        allowed_values:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Allowed Values
      type: object
      title: PartialConfigRequest
      examples:
      - description: The year the device was first seen.
      - allowed_values:
        - s
        - m
        - l
    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