ARMO

ARMO Customer State API

The CustomerState API from ARMO — 6 operation(s) for customerstate.

Documentation GitHub OpenAPI

Operations 8

GET /customerState/gettingStarted Get customer's "getting started" checklist state #

PUT /customerState/gettingStarted Update customer's "getting started" checklist state #

GET /customerState/onboarding Get customer's onboarding state #

PUT /customerState/onboarding Update customer's onboarding state #

GET /customerState/reports/imageScan Get image scan reports state #

GET /customerState/reports/postureScan Get posture reports state #

GET /customerState/reports/registryScan Get registry scan reports state #

GET /customerState/reports/repositoryPostureScan Get repo posture reports state #

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/armosec:armosec-customerstate-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: 'Documentation of Armo Platform API

    How to get the API key Get the API key from the Armo platform


    Navigate to the https://cloud.armosec.io


    Click on Settings (bottom left corner)


    Under the Agent Access Keys section, generate a new access key or use an existing one.


    Copy and save the access key, as it will not appear again.


    Using the API Key in Requests Pass the access key in the request headers under the key x-api-key as shown below:

    curl -X ''POST'' \

    ''https://api.armosec.io/api/v1/some-endpoint'' \

    -H ''accept: application/json'' \

    -H ''x-api-key: YOUR_ACCESS_KEY'' \

    -d ''{}'''
  title: ARMO PLATFORM Customer State API
  version: 1.0.0
servers:
- url: https://api.armosec.io/api/v1
- url: http://api.armosec.io/api/v1
security:
- customerGUID:
  - '[]'
- accessKey:
  - '[]'
- openID:
  - '[]'
tags:
- name: CustomerState
paths:
  /customerState/gettingStarted:
    get:
      description: Returns the "getting started" state
      tags:
      - CustomerState
      summary: Get customer's "getting started" checklist state
      operationId: getGettingStartedState
      responses:
        '200':
          $ref: '#/components/responses/GettingStartedStateResponse'
    put:
      description: Returns the updated state
      tags:
      - CustomerState
      summary: Update customer's "getting started" checklist state
      operationId: updateGettingStartedState
      responses:
        '200':
          $ref: '#/components/responses/GettingStartedStateUpdateResponse'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - type: object
                properties:
                  dismiss:
                    type: boolean
                    x-go-name: Dismiss
  /customerState/onboarding:
    get:
      description: Returns the onboarding state of the customer
      tags:
      - CustomerState
      summary: Get customer's onboarding state
      operationId: getOnboardingState
      responses:
        '200':
          $ref: '#/components/responses/OnboardingStateResponse'
    put:
      description: Returns the updated onboarding state
      tags:
      - CustomerState
      summary: Update customer's onboarding state
      operationId: updateOnboardingState
      responses:
        '200':
          $ref: '#/components/responses/OnboardingStateResponse'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - type: object
                properties:
                  companySize:
                    type: string
                    x-go-name: CompanySize
                  completed:
                    type: boolean
                    x-go-name: Completed
                  interests:
                    type: array
                    items:
                      type: string
                    x-go-name: Interests
                  orgName:
                    type: string
                    x-go-name: OrgName
                  role:
                    type: string
                    x-go-name: Role
  /customerState/reports/imageScan:
    get:
      description: Returns a boolean state - if any image scans exist
      tags:
      - CustomerState
      operationId: getImageScanReportsState
      parameters:
      - x-go-name: IncludeLastReport
        name: includeLastReport
        in: query
        schema:
          type: boolean
      responses:
        '200':
          $ref: '#/components/responses/ReportStateResponse'
      summary: Get image scan reports state
      x-summary-source: derived
  /customerState/reports/postureScan:
    get:
      description: Returns a boolean state - if any posture reports exist
      tags:
      - CustomerState
      operationId: getPostureReportsState
      parameters:
      - x-go-name: IncludeLastReport
        name: includeLastReport
        in: query
        schema:
          type: boolean
      responses:
        '200':
          $ref: '#/components/responses/ReportStateResponse'
      summary: Get posture reports state
      x-summary-source: derived
  /customerState/reports/registryScan:
    get:
      description: Returns a boolean state - if any registry scans exist
      tags:
      - CustomerState
      operationId: getRegistryScanReportsState
      parameters:
      - x-go-name: IncludeLastReport
        name: includeLastReport
        in: query
        schema:
          type: boolean
      responses:
        '200':
          $ref: '#/components/responses/ReportStateResponse'
      summary: Get registry scan reports state
      x-summary-source: derived
  /customerState/reports/repositoryPostureScan:
    get:
      description: Returns a boolean state - if any repository scans exist
      tags:
      - CustomerState
      operationId: getRepoPostureReportsState
      parameters:
      - x-go-name: IncludeLastReport
        name: includeLastReport
        in: query
        schema:
          type: boolean
      responses:
        '200':
          $ref: '#/components/responses/ReportStateResponse'
      summary: Get repo posture reports state
      x-summary-source: derived
components:
  responses:
    GettingStartedStateUpdateResponse:
      description: ''
      content:
        application/json:
          schema:
            allOf:
            - type: object
              properties:
                dismiss:
                  type: boolean
                  x-go-name: Dismiss
    GettingStartedStateResponse:
      description: ''
      content:
        application/json:
          schema:
            allOf:
            - type: object
              properties:
                dismissed:
                  type: boolean
                  x-go-name: Dismissed
                dismissible:
                  type: boolean
                  x-go-name: Dismissible
                everCollaborated:
                  type: boolean
                  x-go-name: EverCollaborated
                everConnectedAlerting:
                  type: boolean
                  x-go-name: EverConnectedAlerting
                everConnectedCluster:
                  type: boolean
                  x-go-name: EverConnectedCluster
                everConnectedTicketing:
                  type: boolean
                  x-go-name: EverConnectedTicketing
                everInvitedTeammate:
                  type: boolean
                  x-go-name: EverInvitedTeammate
                everScannedRegistry:
                  type: boolean
                  x-go-name: EverScannedRegistry
                everScannedRepository:
                  type: boolean
                  x-go-name: EverScannedRepository
                everUsedRbacVisualizer:
                  type: boolean
                  x-go-name: EverUsedRbacVisualizer
    ReportStateResponse:
      description: ''
      content:
        application/json:
          schema:
            allOf:
            - type: object
              properties:
                exists:
                  type: boolean
                  x-go-name: Exists
                lastReport:
                  x-go-name: LastReport
    OnboardingStateResponse:
      description: ''
      content:
        application/json:
          schema:
            allOf:
            - type: object
              properties:
                companySize:
                  type: string
                  x-go-name: CompanySize
                completed:
                  type: boolean
                  x-go-name: Completed
                interests:
                  type: array
                  items:
                    type: string
                  x-go-name: Interests
                orgName:
                  type: string
                  x-go-name: OrgName
                role:
                  type: string
                  x-go-name: Role
  securitySchemes:
    accessKey:
      type: apiKey
      name: x-api-key
      in: header
    customerGUID:
      type: apiKey
      name: customerGUID
      in: query
x-provenance:
  method: harvested
  publisher: ARMO
  source: https://api.armosec.io/openapi/v2/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)