APIs.io Engineering Platform GitHub v3 REST API — Secret-Scanning

naftiko: 1.0.0-alpha2
info:
  label: APIs.io Engineering Platform GitHub v3 REST API — Secret-Scanning
  description: 'APIs.io Engineering Platform GitHub v3 REST API — Secret-Scanning. 6 operations. Lead operation: APIs.io Engineering
    Platform List secret scanning alerts for an enterprise. Self-contained Naftiko capability covering one Engineering Platform
    business surface.'
  tags:
  - Engineering Platform
  - Secret-Scanning
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ENGINEERING_PLATFORM_API_KEY: ENGINEERING_PLATFORM_API_KEY
capability:
  consumes:
  - type: http
    namespace: github-secret-scanning
    baseUri: ''
    description: APIs.io Engineering Platform GitHub v3 REST API — Secret-Scanning business capability. Self-contained, no
      shared references.
    resources:
    - name: enterprises-enterprise-secret-scanning-alerts
      path: /enterprises/{enterprise}/secret-scanning/alerts
      operations:
      - name: secretscanninglistalertsforenterprise
        method: GET
        description: APIs.io Engineering Platform List secret scanning alerts for an enterprise
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: orgs-org-secret-scanning-alerts
      path: /orgs/{org}/secret-scanning/alerts
      operations:
      - name: secretscanninglistalertsfororg
        method: GET
        description: APIs.io Engineering Platform List secret scanning alerts for an organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: repos-owner-repo-secret-scanning-alerts
      path: /repos/{owner}/{repo}/secret-scanning/alerts
      operations:
      - name: secretscanninglistalertsforrepo
        method: GET
        description: APIs.io Engineering Platform List secret scanning alerts for a repository
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: repos-owner-repo-secret-scanning-alerts-alert_number
      path: /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}
      operations:
      - name: secretscanninggetalert
        method: GET
        description: APIs.io Engineering Platform Get a secret scanning alert
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: secretscanningupdatealert
        method: PATCH
        description: APIs.io Engineering Platform Update a secret scanning alert
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: repos-owner-repo-secret-scanning-alerts-alert_number-locations
      path: /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations
      operations:
      - name: secretscanninglistlocationsforalert
        method: GET
        description: APIs.io Engineering Platform List locations for a secret scanning alert
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: github-secret-scanning-rest
    port: 8080
    description: REST adapter for APIs.io Engineering Platform GitHub v3 REST API — Secret-Scanning. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/enterprises/{enterprise}/secret-scanning/alerts
      name: enterprises-enterprise-secret-scanning-alerts
      description: REST surface for enterprises-enterprise-secret-scanning-alerts.
      operations:
      - method: GET
        name: secretscanninglistalertsforenterprise
        description: APIs.io Engineering Platform List secret scanning alerts for an enterprise
        call: github-secret-scanning.secretscanninglistalertsforenterprise
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orgs/{org}/secret-scanning/alerts
      name: orgs-org-secret-scanning-alerts
      description: REST surface for orgs-org-secret-scanning-alerts.
      operations:
      - method: GET
        name: secretscanninglistalertsfororg
        description: APIs.io Engineering Platform List secret scanning alerts for an organization
        call: github-secret-scanning.secretscanninglistalertsfororg
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/repos/{owner}/{repo}/secret-scanning/alerts
      name: repos-owner-repo-secret-scanning-alerts
      description: REST surface for repos-owner-repo-secret-scanning-alerts.
      operations:
      - method: GET
        name: secretscanninglistalertsforrepo
        description: APIs.io Engineering Platform List secret scanning alerts for a repository
        call: github-secret-scanning.secretscanninglistalertsforrepo
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/repos/{owner}/{repo}/secret-scanning/alerts/{alert-number}
      name: repos-owner-repo-secret-scanning-alerts-alert-number
      description: REST surface for repos-owner-repo-secret-scanning-alerts-alert_number.
      operations:
      - method: GET
        name: secretscanninggetalert
        description: APIs.io Engineering Platform Get a secret scanning alert
        call: github-secret-scanning.secretscanninggetalert
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: secretscanningupdatealert
        description: APIs.io Engineering Platform Update a secret scanning alert
        call: github-secret-scanning.secretscanningupdatealert
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/repos/{owner}/{repo}/secret-scanning/alerts/{alert-number}/locations
      name: repos-owner-repo-secret-scanning-alerts-alert-number-locations
      description: REST surface for repos-owner-repo-secret-scanning-alerts-alert_number-locations.
      operations:
      - method: GET
        name: secretscanninglistlocationsforalert
        description: APIs.io Engineering Platform List locations for a secret scanning alert
        call: github-secret-scanning.secretscanninglistlocationsforalert
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: github-secret-scanning-mcp
    port: 9090
    transport: http
    description: MCP adapter for APIs.io Engineering Platform GitHub v3 REST API — Secret-Scanning. One tool per consumed
      operation, routed inline through this capability's consumes block.
    tools:
    - name: apis-io-engineering-platform-list-secret
      description: APIs.io Engineering Platform List secret scanning alerts for an enterprise
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: github-secret-scanning.secretscanninglistalertsforenterprise
      outputParameters:
      - type: object
        mapping: $.
    - name: apis-io-engineering-platform-list-secret-2
      description: APIs.io Engineering Platform List secret scanning alerts for an organization
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: github-secret-scanning.secretscanninglistalertsfororg
      outputParameters:
      - type: object
        mapping: $.
    - name: apis-io-engineering-platform-list-secret-3
      description: APIs.io Engineering Platform List secret scanning alerts for a repository
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: github-secret-scanning.secretscanninglistalertsforrepo
      outputParameters:
      - type: object
        mapping: $.
    - name: apis-io-engineering-platform-get-secret
      description: APIs.io Engineering Platform Get a secret scanning alert
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: github-secret-scanning.secretscanninggetalert
      outputParameters:
      - type: object
        mapping: $.
    - name: apis-io-engineering-platform-update-secret
      description: APIs.io Engineering Platform Update a secret scanning alert
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: github-secret-scanning.secretscanningupdatealert
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: apis-io-engineering-platform-list-locations
      description: APIs.io Engineering Platform List locations for a secret scanning alert
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: github-secret-scanning.secretscanninglistlocationsforalert
      outputParameters:
      - type: object
        mapping: $.