Britive Applications - Scans API

openapi: 3.2.0
info:
  title: Britive Services API Documentation Applications - Scans API
  version: v1
  description: API documentation for Users, Tags, Identity providers, Applications, Reporting, Audit logs, Tenants, SSO, Profiles, Password policies, MFA, Access Builder Settings, etc.
servers:
- url: https://{tenantURL}
  description: The primary server
  variables:
    tenantURL:
      default: test.britive-app.com
      description: The host of the server
security:
- bearerAuth: []
tags:
- name: Applications - Scans
  description: Manage Application Scans
paths:
  /api/apps/{appContainerId}/full-scan:
    post:
      tags:
      - Applications - Scans
      summary: Scan all environments for a specified application
      operationId: fullScanForNonHierarchicalApp
      parameters:
      - name: appContainerId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FullScanResponse'
  /api/apps/{appContainerId}/scans/env-status/history:
    get:
      tags:
      - Applications - Scans
      summary: GET a list of all scans in the past 90 days for the application id given in the request
      description: The data is returned in pages. Multiple API calls have to be made to return the complete list.
      operationId: scanStatusHistoryForApp
      parameters:
      - name: appContainerId
        in: path
        required: true
        schema:
          type: string
      - name: filter
        in: query
        required: false
        schema:
          type: string
      - name: searchText
        in: query
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/Size'
      - $ref: '#/components/parameters/Sort'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
  /api/apps/{id}/scan:
    post:
      tags:
      - Applications - Scans
      summary: Run an organization scan for the specified application
      operationId: appScanner
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: orgScanOnly
        description: If this parameter is set to true, only organization scan runs for Azure and GCP (Environment scan is not triggered.) The default value when this query parameter is not passed is false.
        in: query
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
components:
  parameters:
    Sort:
      name: sort
      in: query
      required: false
      description: parameter to specify the sort parameter and direction
      schema:
        type: string
    Page:
      name: page
      in: query
      required: false
      description: Parameter to specify the page number of the records to retrieve
      schema:
        type: integer
        default: 0
    Size:
      name: size
      in: query
      required: false
      description: parameter to specify the number of records to retrieve per page
      schema:
        type: integer
        default: 20
  schemas:
    FullScanResponse:
      type: object
      properties:
        message:
          type: string
        environments:
          type: array
          items:
            $ref: '#/components/schemas/FullScanEnvironment'
    FullScanEnvironment:
      type: object
      properties:
        name:
          type: string
        message:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
x-api-evangelist:
  assembled_from: https://docs.britive.com/apidocs/ (one OpenAPI fragment per operation page, .md variant)
  assembled_on: '2026-08-08'
  fragments: 372
  note: Britive publishes this contract only as per-operation fragments inside its Document360 API reference. This file is the faithful union of those fragments; the verbatim assembly is in openapi/_original/.