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/flatfile-subpackage-agent-exports-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:
  title: Reference subpackage_accounts Subpackage Agent Exports API
  version: 1.0.0
servers:
- url: https://api.x.flatfile.com/v1
tags:
- name: subpackage_agent-exports
paths:
  /agent-exports:
    get:
      operationId: list
      summary: List agent exports
      tags:
      - subpackage_agent-exports
      parameters:
      - name: environmentId
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons_EnvironmentId'
      - name: agentId
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons_AgentId'
      - name: pageSize
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons_PageSize'
      - name: pageNumber
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons_PageNumber'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_agent-exports_ListAgentExportsResponse'
  /agent-exports/{agentExportId}:
    get:
      operationId: get
      summary: Get an agent export
      tags:
      - subpackage_agent-exports
      parameters:
      - name: agentExportId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_AgentExportId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_agent-exports_GetAgentExportResponse'
    delete:
      operationId: delete
      summary: Delete an agent export
      tags:
      - subpackage_agent-exports
      parameters:
      - name: agentExportId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_AgentExportId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Success'
  /agent-exports/{agentExportId}/download:
    get:
      operationId: download
      summary: Download an agent export
      tags:
      - subpackage_agent-exports
      parameters:
      - name: agentExportId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_AgentExportId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
components:
  schemas:
    type_agent-exports_AgentExportType:
      type: string
      enum:
      - AUTOBUILD_INLINED
      - SYSTEM_COMBINED
      - SOURCE
      description: The different export type formats available.
      title: AgentExportType
    type_agent-exports_ListAgentExportsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_agent-exports_AgentExport'
        pagination:
          $ref: '#/components/schemas/type_commons_Pagination'
      required:
      - data
      - pagination
      title: ListAgentExportsResponse
    type_commons_PageNumber:
      type: integer
      description: Based on pageSize, which page of records to return
      title: PageNumber
    type_commons_AgentId:
      type: string
      description: Agent ID
      title: AgentId
    type_commons_AccountId:
      type: string
      description: Account ID
      title: AccountId
    type_commons_PageSize:
      type: integer
      description: Number of logs to return in a page (default 20)
      title: PageSize
    type_commons_Pagination:
      type: object
      properties:
        currentPage:
          type: integer
          description: current page of results
        pageCount:
          type: integer
          description: total number of pages of results
        totalCount:
          type: integer
          description: total available results
      required:
      - currentPage
      - pageCount
      - totalCount
      description: pagination info
      title: Pagination
    type_commons_AgentExportId:
      type: string
      description: Agent Export ID
      title: AgentExportId
    type_agent-exports_AgentExport:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons_AgentExportId'
        agentId:
          $ref: '#/components/schemas/type_commons_AgentId'
        exportType:
          $ref: '#/components/schemas/type_agent-exports_AgentExportType'
        accountId:
          $ref: '#/components/schemas/type_commons_AccountId'
        environmentId:
          $ref: '#/components/schemas/type_commons_EnvironmentId'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        deletedAt:
          type: string
          format: date-time
      required:
      - id
      - agentId
      - exportType
      - accountId
      - environmentId
      - createdAt
      - updatedAt
      title: AgentExport
    type_commons_Success:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_commons_SuccessData'
      description: Informs whether or not a request was successful
      title: Success
    type_agent-exports_GetAgentExportResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_agent-exports_AgentExport'
      required:
      - data
      title: GetAgentExportResponse
    type_commons_SuccessData:
      type: object
      properties:
        success:
          type: boolean
      required:
      - success
      title: SuccessData
    type_commons_EnvironmentId:
      type: string
      description: Environment ID
      title: EnvironmentId
  securitySchemes:
    default:
      type: http
      scheme: bearer