StackRox ExternalBackupService API

The ExternalBackupService API from StackRox — 3 operation(s) for externalbackupservice.

Operations 7

GET /v1/externalbackups #
POST /v1/externalbackups #
POST /v1/externalbackups/test #
GET /v1/externalbackups/{id} #
DELETE /v1/externalbackups/{id} #
POST /v1/externalbackups/{id} #
PUT /v1/externalbackups/{id} #

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/stackrox-externalbackupservice-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.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

stackrox-externalbackupservice-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Reference AlertService External Backup Service API
  version: '1'
  description: API reference for the StackRox Kubernetes Security Platform (upstream of Red Hat Advanced Cluster Security). Provides risk analysis, visibility, runtime alerts, policy management, compliance checking, and vulnerability management for containerized workloads. Authentication uses API tokens generated via /v1/apitokens/generate and passed as Bearer tokens.
  contact:
    email: support@stackrox.com
    url: https://www.stackrox.io/
  license:
    name: All Rights Reserved
    url: https://www.stackrox.com/
servers:
- url: https://{central-host}
  description: StackRox Central API server
  variables:
    central-host:
      default: stackrox.localhost
      description: StackRox Central hostname or IP
security:
- ApiToken: []
tags:
- name: ExternalBackupService
paths:
  /v1/externalbackups:
    get:
      operationId: GetExternalBackups
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1GetExternalBackupsResponse'
      tags:
      - ExternalBackupService
    post:
      operationId: PostExternalBackup
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/storageExternalBackup'
      requestBody:
        $ref: '#/components/requestBodies/storageExternalBackup'
      tags:
      - ExternalBackupService
  /v1/externalbackups/test:
    post:
      operationId: TestExternalBackup
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Empty'
      requestBody:
        $ref: '#/components/requestBodies/storageExternalBackup'
      tags:
      - ExternalBackupService
  /v1/externalbackups/{id}:
    get:
      operationId: GetExternalBackup
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/storageExternalBackup'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      tags:
      - ExternalBackupService
    delete:
      operationId: DeleteExternalBackup
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Empty'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      tags:
      - ExternalBackupService
    post:
      operationId: TriggerExternalBackup
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Empty'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      tags:
      - ExternalBackupService
    put:
      operationId: PutExternalBackup
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/storageExternalBackup'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/storageExternalBackup'
      tags:
      - ExternalBackupService
components:
  schemas:
    storageExternalBackup:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        type:
          type: string
        schedule:
          $ref: '#/components/schemas/storageSchedule'
        backupsToKeep:
          type: integer
          format: int32
        s3:
          $ref: '#/components/schemas/storageS3Config'
    v1GetExternalBackupsResponse:
      type: object
      properties:
        externalBackups:
          type: array
          items:
            $ref: '#/components/schemas/storageExternalBackup'
    ScheduleIntervalType:
      type: string
      enum:
      - UNSET
      - DAILY
      - WEEKLY
      default: UNSET
    v1Empty:
      type: object
    storageS3Config:
      type: object
      properties:
        bucket:
          type: string
        useIam:
          type: boolean
          format: boolean
        accessKeyId:
          type: string
        secretAccessKey:
          type: string
        region:
          type: string
        objectPrefix:
          type: string
    storageSchedule:
      type: object
      properties:
        intervalType:
          $ref: '#/components/schemas/ScheduleIntervalType'
        hour:
          type: integer
          format: int32
        minute:
          type: integer
          format: int32
        weekly:
          $ref: '#/components/schemas/ScheduleWeeklyInterval'
    ScheduleWeeklyInterval:
      type: object
      properties:
        day:
          type: integer
          format: int32
  requestBodies:
    storageExternalBackup:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/storageExternalBackup'
      required: true
  securitySchemes:
    ApiToken:
      type: apiKey
      in: header
      name: Authorization
      description: 'StackRox API token. Format: Bearer {token}'