openapi: 3.2.0
info:
  contact: {}
  description: "Access Keys are a secure way to enable programmatic access to the Prisma Cloud API. By default, only \nthe System Admin has API access and can enable API access for other administrators. If you have API access, \nyou can create up to two access keys. Create an access key for a limited time period and regenerate your API \nkeys periodically to minimize exposure and follow security best practices.\n"
  title: Prisma Cloud Access Keys API Overview Onboarding AWS S3 Flow Logs API
  version: Latest
servers:
- url: https://api.prismacloud.io
- url: https://api2.prismacloud.io
- url: https://api3.prismacloud.io
- url: https://api4.prismacloud.io
tags:
- description: "You can use the AWS S3 Flow Logs API for AWS S3 onboarding for organization \nand standalone accounts on all supported stacks.\n"
  name: Onboarding AWS S3 Flow Logs
paths:
  /cloud-accounts-manager/v1/cloud-accounts/aws/{accountId}/features/aws-flow-logs/s3:
    get:
      description: Fetches AWS S3 Flow Log feature details of monitored account.
      operationId: get-aws-s3-flowlog
      parameters:
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/AwsS3FlowLogsModel'
          description: success
        '400':
          description: invalid_parameter_value / bad_request
        '401':
          description: unauthorized_access
        '404':
          description: account_not_exist_or_disabled / AWS Flow Logs S3 feature not configured
        '500':
          description: internal_error
      security:
      - x-redlock-auth: []
      summary: Fetches AWS S3 Flow Log details
      tags:
      - Onboarding AWS S3 Flow Logs
    patch:
      description: Saves AWS S3 Flow Log feature details of monitored account.
      operationId: save-aws-s3-flowlog
      parameters:
      - description: 1 Hour format
        in: query
        name: isHourlyFormat
        required: true
        schema:
          type: boolean
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AwsS3FlowLogsModel'
        description: AWS S3 Flow Logs feature
        required: true
      responses:
        '201':
          description: success
        '400':
          description: invalid_parameter_value / bad_request / missing_required_parameter / Logging account and monitored account are in different partition / logging_account_bucket_not_found / AWS Flow Logs S3 feature not supported for account
        '401':
          description: unauthorized_access
        '404':
          description: account_not_exist_or_disabled / logging_account_not_exists
        '500':
          description: internal_error
      security:
      - x-redlock-auth: []
      summary: Saves AWS S3 Flow Log details
      tags:
      - Onboarding AWS S3 Flow Logs
  /cloud-accounts-manager/v1/cloud-accounts/aws/{accountId}/features/aws-flow-logs/s3/status:
    post:
      description: Checks AWS S3 Flow Log status of monitored account.
      operationId: check-aws-s3-flowlog
      parameters:
      - description: 1 Hour format
        in: query
        name: isHourlyFormat
        required: true
        schema:
          type: boolean
      - in: path
        name: accountId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AwsS3FlowLogsLoggingAccountsModel'
        description: AWS S3 Flow Logs feature
        required: true
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CloudAccountStatus'
          description: success
        '400':
          description: invalid_parameter_value / bad_request / AWS Flow Logs S3 feature not supported for account
        '401':
          description: unauthorized_access
        '404':
          description: invalid_account_id_format
        '500':
          description: internal_error
      security:
      - x-redlock-auth: []
      summary: Checks AWS S3 Flow Log status
      tags:
      - Onboarding AWS S3 Flow Logs
components:
  schemas:
    CloudAccountStatus:
      properties:
        id:
          type: string
        name:
          type: string
        status:
          type: string
        statusMessage:
          $ref: '#/components/schemas/AccountStatusMessage'
      type: object
    AwsS3FlowLogsModel:
      description: Model for AWS S3 Flow Logs Feature Configuration
      properties:
        accountId:
          description: Prisma Account ID from cloud_account table
          format: int32
          type: integer
        loggingAccounts:
          description: List of logging accounts with selected buckets for the given feature
          items:
            $ref: '#/components/schemas/AwsS3FlowLogsLoggingAccountsModel'
          type: array
      type: object
    AwsS3FlowLogsLoggingAccountsModel:
      description: Model for AWS S3 Flow Logs Feature Logging Accounts Configuration
      properties:
        awsS3FlowLogsLoggingAccountId:
          description: Logging Account Internal ID
          format: int32
          type: integer
        bucketIds:
          description: List of bucket Ids for the feature
          items:
            format: int32
            type: integer
          type: array
        buckets:
          description: List of buckets for the feature
          items:
            type: string
          type: array
        loggingAccountId:
          description: Account ID of the Logging Account
          type: string
      type: object
    AccountStatusMessage:
      properties:
        message:
          type: string
        staticMessage:
          type: boolean
      type: object
  securitySchemes:
    x-redlock-auth:
      description: The x-redlock-auth value is a JSON Web Token (JWT).
      in: header
      name: x-redlock-auth
      type: apiKey