ARMO

ARMO Registry API

Container registry scanning.

Documentation GitHub OpenAPI

Business capability

Vulnerability Management BC-620.40

Operations 3

PUT /registry/scan Update registry scan #

POST /registry/scan Post registry scan #

DELETE /registry/scan Delete registry scan #

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-registry-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 Registry 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: Registry
paths:
  /registry/scan:
    put:
      description: Update registry cron job
      tags:
      - Registry
      operationId: updateRegistryScan
      responses:
        '202':
          $ref: '#/components/responses/RegistryScanResponse'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/RegistryJobParams'
      summary: Update registry scan
      x-summary-source: derived
    post:
      description: Issue a scan for a specific registry or set sceduler to scan(if CronTabSchedule is not empty)
      tags:
      - Registry
      operationId: postRegistryScan
      responses:
        '202':
          $ref: '#/components/responses/RegistryScanResponse'
        '400':
          $ref: '#/components/responses/BadRequestResponse'
        '403':
          description: ''
        '500':
          $ref: '#/components/responses/SysterErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/RegistryScanRequest'
      summary: Post registry scan
      x-summary-source: derived
    delete:
      description: Delete registry cron job
      tags:
      - Registry
      operationId: deleteRegistryScan
      responses:
        '202':
          $ref: '#/components/responses/RegistryScanResponse'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/RegistryJobParams'
      summary: Delete registry scan
      x-summary-source: derived
components:
  responses:
    RegistryScanResponse:
      description: ''
      content:
        application/json:
          schema:
            type: array
            items:
              type: object
              properties:
                clusterName:
                  type: string
                  x-go-name: ClusterName
                cronTabSchedule:
                  type: string
                  x-go-name: CronTabSchedule
                id:
                  type: string
                  x-go-name: ID
                jobID:
                  type: string
                  x-go-name: JobID
                name:
                  type: string
                  x-go-name: Name
                registryName:
                  type: string
                  x-go-name: RegistryName
    BadRequestResponse:
      description: ''
      content:
        application/json:
          schema:
            type: array
            items:
              type: object
              properties:
                detail:
                  description: Error detail (Optional)
                  type: string
                  x-go-name: Detail
                  example: '"invalid set crone job request"'
                message:
                  description: User-Friendly Error Messages (Optional)
                  type: string
                  x-go-name: Message
                  example: '"You are running an old version of Kubescape Helm chart"'
                url:
                  description: URL to documentation / future investigation (Optional)
                  type: string
                  x-go-name: URL
                  example: '"https://docs.armo.cloud"'
    SysterErrorResponse:
      description: ''
      content:
        application/json:
          schema:
            type: array
            items:
              type: object
              properties:
                detail:
                  description: Error detail (Optional)
                  type: string
                  x-go-name: Detail
                  example: '"invalid set crone job request"'
                message:
                  description: User-Friendly Error Messages (Optional)
                  type: string
                  x-go-name: Message
                  example: '"You are running an old version of Kubescape Helm chart"'
                url:
                  description: URL to documentation / future investigation (Optional)
                  type: string
                  x-go-name: URL
                  example: '"https://docs.armo.cloud"'
  schemas:
    RegistryJobParams:
      type: object
      properties:
        clusterName:
          type: string
          x-go-name: ClusterName
        cronTabSchedule:
          type: string
          x-go-name: CronTabSchedule
        id:
          type: string
          x-go-name: ID
        jobID:
          type: string
          x-go-name: JobID
        name:
          type: string
          x-go-name: Name
        registryName:
          type: string
          x-go-name: RegistryName
      x-go-package: github.com/armosec/armoapi-go/armotypes
    RegistryScanRequest:
      type: object
      properties:
        clusterName:
          description: ClusterName
          type: string
          x-go-name: ClusterName
          example: logging-prod
        cronTabSchedule:
          description: CronTabSchedule is optional
          type: string
          x-go-name: CronTabSchedule
          example: 22 */2 * * *
        registryName:
          description: RegistryName
          type: string
          x-go-name: RegistryName
          example: red-team/web
      x-go-package: github.com/armosec/cadashboardbe/docs
  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)