APIs.io Engineering Platform Private API Network API

openapi: 3.2.0
info:
  title: APIs.io Engineering Platform Postman Private API Network API
  description: "The Postman API enables you to programmatically access data stored in your Postman account.\n\n> Certain endpoints may be unavailable depending on your region and/or Postman plan.\n\nFor a comprehensive set of examples of requests and responses, see the [**Postman API** collection](https://www.postman.com/postman/workspace/postman-public-workspace/documentation/12959542-c8142d51-e97c-46b6-bd77-52bb66712c9a).\n\n## Getting started\n\nYou can get started with the Postman API by creating a copy of this definition in your workspace.\n\n### EU users\n\nFor users in the EU with [**Enterprise** plans](https://www.postman.com/pricing/), the Postman API uses the `http://api.eu.postman.com` subdomain. This is available in the definition's list of servers. You can change this by selecting the `http://api.eu.postman.com` subdomain in the **Server** dropdown list below.\n\n## About the Postman API\n\n- You must use a valid API Key to send requests to the API endpoints.\n- The API has [rate and usage limits](https://learning.postman.com/docs/developer/postman-api/postman-api-rate-limits/).\n- The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP `301` redirect to the corresponding HTTPS resources.\n- The API returns requests responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.\n- The request method (verb) determines the nature of action you intend to perform. A request made using the `GET` method implies that you want to fetch something from Postman. The `POST` method implies you want to save something new to Postman.\n- For all requests, API calls respond with their corresponding [HTTP status codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes). In the Postman client, the status code also provides help text that details the possible meaning of the response code.\n- When calling the API Builder endpoints, you must send an `Accept` header with the `application/vnd.api.v10+json` value.\n\n### IDs and UIDs\n\nAll items in Postman, such as collections, workspaces, and APIs, have IDs and UIDs:\n\n- An ID is the unique ID assigned to a Postman item. For example, `ec29121c-5203-409f-9e84-e83ffc10f226`.\n- The UID is the **full** ID of a Postman item. This value is the item's unique ID concatenated with the user ID. For example, in the `12345678-ec29121c-5203-409f-9e84-e83ffc10f226` UID:\n    - `12345678` is the user's ID.\n    - `ec29121c-5203-409f-9e84-e83ffc10f226` is the item's ID.\n\n### Enum values\n\nAny documented enum values should be considered partial lists and may change over time.\n\n### 403 response for unavailable features\n\nDepending on your region and/or Postman [plan](https://www.postman.com/pricing/), some endpoints will return an HTTP `403 Forbidden` response with the \"This feature isn't available in your region.\" detail.\n\n### 503 response\n\nAn HTTP `503 Service Unavailable` response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes.\n\nIf the outage persists or you receive any other form of an HTTP `5XX` error, [contact support](https://support.postman.com/hc/en-us/requests/new/).\n\n## Authentication\n\nPostman uses API keys for authentication. The API key tells the API server that the request came from you. Everything that you have access to in Postman is accessible with your API key. You can [generate](https://learning.postman.com/docs/developer/postman-api/authentication/#generate-a-postman-api-key) a Postman API key in the [**API keys**](https://postman.postman.co/settings/me/api-keys) section of your Postman account settings.\n\nYou must include an API key in each request to the Postman API with the `X-API-Key` request header. In Postman, you can store your API key as a [vault secret](https://learning.postman.com/docs/sending-requests/postman-vault/postman-vault-secrets/) or an [environment variable](https://www.getpostman.com/docs/environments). The Postman API [collection](https://www.getpostman.com/docs/collections) will use it to make API calls.\n\n### SCIM authentication\n\nWhile all other endpoints in this collection require a Postman API key, the SCIM endpoints require a [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key).\n\n### Authentication error response\n\nIf an API key is missing, malformed, or invalid, you will receive an HTTP `401 Unauthorized` response code.\n\n## Rate and usage limits\n\nAPI access [rate limits](https://learning.postman.com/docs/developer/postman-api/postman-api-rate-limits/) apply at a per-user basis in unit time. The limit is **300 requests per minute**. Postman Monitors, the GET `/collections`, and the GET `/workspaces` endpoint have a rate limit of **10 calls in 10 seconds**. Depending on your [plan](https://www.postman.com/pricing/), you may also have [usage limits](https://learning.postman.com/docs/billing/resource-usage/).\n\nWhen you reach your rate or usage limits, the API returns the following HTTP `429 Too Many Requests` status code with one of the following error responses:\n\n- `rateLimited` — Rate limits reached. The response returns the time after which you can resume calls to the Postman API.\n- `serviceLimitExhausted` — Postman API service limits reached. You will need to contact your Postman Team Admin for assistance.\n\n## Support\n\nFor help regarding accessing the Postman API, you can:\n\n- Visit [Postman Support](https://support.postman.com/hc/en-us) or our [Community and Support](https://www.postman.com/community/) sites.\n- Reach out to the [Postman community](https://community.postman.com/).\n- Submit a help request to [Postman support](https://support.postman.com/hc/en-us/requests/new/).\n\n## Policies\n\n- [Postman Terms of Service](http://www.postman.com/legal/terms/)\n- [Postman Privacy Policy](https://www.postman.com/legal/privacy-policy/)\n"
  version: '1.0'
  termsOfService: https://www.postman.com/legal/terms/
  contact:
    name: Postman Support
    email: help@postman.com
    url: https://www.postman.com/community/
servers:
- url: https://api.getpostman.com
- url: https://api.eu.postman.com
security:
- PostmanApiKey: []
- scimApiKey: []
tags:
- name: Private API Network
  description: The **Private API Network** endpoints enable you to manage and work with your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/). These endpoints are only available on Postman [**Enterprise** plans](https://www.postman.com/pricing/#enterprise-solutions).
paths:
  /network/private:
    get:
      summary: APIs.io Engineering Platform Get all elements and folders
      description: 'Gets information about the folders and their elements added to your [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).


        **Note:**


        The `limit` and `offset` parameters are separately applied to elements and folders. For example, if you query a `limit` value of `10` and an `offset` value `0`, the endpoint returns 10 elements and 10 folders for a total of 20 items. The `totalCount` property in the `meta` response is the total count of both elements and folders.

        '
      operationId: getAllElementsAndFolders
      x-postman-plan: Enterprise
      tags:
      - Private API Network
      responses:
        '200':
          $ref: '#/components/responses/getPanElementsAndFolders'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/common403Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
      parameters:
      - $ref: '#/components/parameters/since'
      - $ref: '#/components/parameters/until'
      - $ref: '#/components/parameters/panAddedBy'
      - $ref: '#/components/parameters/panElementName'
      - $ref: '#/components/parameters/panSummary'
      - $ref: '#/components/parameters/panElementDescription'
      - $ref: '#/components/parameters/sortCreatedUpdatedAt'
      - $ref: '#/components/parameters/direction'
      - $ref: '#/components/parameters/createdBy'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/limitDefault1000'
      - $ref: '#/components/parameters/panParentFolderId'
      - $ref: '#/components/parameters/elementTypeQuery'
    post:
      summary: APIs.io Engineering Platform Add an element or folder
      description: 'Publishes a element or creates a folder in your [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/). An element is a Postman API, collection, or workspace.


        **Note:**


        You can only pass one element object type per call. For example, you cannot pass both `api` and `collection` in a single request.

        '
      tags:
      - Private API Network
      operationId: postPanElementOrFolder
      x-postman-plan: Enterprise
      requestBody:
        $ref: '#/components/requestBodies/postPanElementOrFolder'
      responses:
        '201':
          $ref: '#/components/responses/postPanElementOrFolder'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/common403Error'
        '404':
          $ref: '#/components/responses/instanceNotFoundElementFolder'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
  /network/private/{elementType}/{elementId}:
    parameters:
    - $ref: '#/components/parameters/elementId'
    - $ref: '#/components/parameters/elementType'
    put:
      summary: APIs.io Engineering Platform Update an element or folder
      description: 'Updates an element or folder in your [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).


        **Note:**


        You can only pass one element object type per call. For example, you cannot pass both `api` and `collection` in a single request.

        '
      operationId: updatePanElementOrFolder
      x-postman-plan: Enterprise
      tags:
      - Private API Network
      requestBody:
        $ref: '#/components/requestBodies/updatePanElementOrFolder'
      responses:
        '200':
          $ref: '#/components/responses/updatePanElementOrFolder'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/common403Error'
        '404':
          $ref: '#/components/responses/instanceNotFoundElementFolder'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
    delete:
      summary: APIs.io Engineering Platform Remove an element or folder
      description: 'Removes an element or delete a folder from your [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).


        **Note:**


        Removing an API, collection, or workspace element does not delete it. It only removes it from the Private API Network folder.

        '
      tags:
      - Private API Network
      operationId: deletePanElementOrFolder
      x-postman-plan: Enterprise
      responses:
        '200':
          $ref: '#/components/responses/deletePanElementOrFolder'
        '400':
          $ref: '#/components/responses/panFolder400ErrorNotEmpty'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/common403Error'
        '404':
          $ref: '#/components/responses/instanceNotFoundElementFolder'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
  /network/private/network-entity/request/all:
    get:
      summary: APIs.io Engineering Platform Get all element add requests
      description: Gets a list requests to add elements to the [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).
      tags:
      - Private API Network
      operationId: getAllPanAddElementRequests
      x-postman-plan: Enterprise
      responses:
        '200':
          $ref: '#/components/responses/getAllPanAddElementRequests'
        '400':
          $ref: '#/components/responses/pan400ErrorInvalidQueryParams'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/common403Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
      parameters:
      - $ref: '#/components/parameters/since'
      - $ref: '#/components/parameters/until'
      - $ref: '#/components/parameters/panRequestedBy'
      - $ref: '#/components/parameters/elementTypeQuery'
      - $ref: '#/components/parameters/panRequestStatus'
      - $ref: '#/components/parameters/panElementName'
      - $ref: '#/components/parameters/sortCreatedUpdatedAt'
      - $ref: '#/components/parameters/direction'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/limitDefault1000'
  /network/private/network-entity/request/{requestId}:
    parameters:
    - $ref: '#/components/parameters/panRequestId'
    put:
      summary: APIs.io Engineering Platform Respond to an element add request
      description: Responds to a request to add an element to the [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/). Only managers can approve or deny a request. Once approved, the element will appear in the team's Private API Network.
      tags:
      - Private API Network
      operationId: respondPanElementAddRequest
      x-postman-plan: Enterprise
      requestBody:
        $ref: '#/components/requestBodies/respondPanElementAddRequest'
      responses:
        '200':
          $ref: '#/components/responses/respondPanElementAddRequest'
        '400':
          $ref: '#/components/responses/pan400ErrorInvalidParams'
        '401':
          $ref: '#/components/responses/common401Error'
        '403':
          $ref: '#/components/responses/common403Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
components:
  responses:
    pan400ErrorInvalidParams:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/pan400ErrorInvalidParams'
          example:
            name: invalidParamsError
            message: Status type can only be denied or approved.
    respondPanElementAddRequest:
      description: Successful Response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/respondPanElementAddRequestResponse'
          example:
            request:
            - id: 2
              createdAt: '2022-06-09T14:48:45.000Z'
              createdBy: 12345678
              message: Please add this to the network
              status: denied
              element:
                type: api
                id: 5360b75f-447e-467c-9299-12fd3c92450d
                name: Test API
                summary: This is a test API
              response:
                createdAt: '2022-06-09T14:48:45.000Z'
                createdBy: 87654321
                message: Please fix the API issues first
    common401Error:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/unauthorized
              title:
                type: string
                description: A short summary of the problem.
                example: Unauthorized
              detail:
                type: string
                description: Information about the error.
                example: Unauthorized
              status:
                type: integer
                format: http-status-code
                description: The error's HTTP status code.
                example: 401
          example:
            type: https://api.postman.com/problems/unauthorized
            title: Unauthorized
            detail: Unauthorized
            status: 401
    instanceNotFoundElementFolder:
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/instanceNotFoundElementFolder'
          example:
            error:
              name: instanceNotFoundError
              message: The specified API does not exist.
    panFolder400ErrorNotEmpty:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/panFolder400ErrorNotEmpty'
          example:
            name: folderNotEmptyError
            message: You need to empty this folder before deleting it.
    updatePanElementOrFolder:
      description: Successful Response
      content:
        application/json:
          schema:
            oneOf:
            - $ref: '#/components/schemas/panElementCreated'
            - $ref: '#/components/schemas/panFolderCreated'
          examples:
            Update Collection:
              value:
                addedAt: '2022-12-07T18:22:15.000Z'
                addedBy: 12345678
                createdBy: 12345678
                createdAt: '2022-12-07T18:22:15.000Z'
                updatedBy: 12345678
                updatedAt: '2022-12-07T18:22:15.000Z'
                type: collection
                id: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
                name: Billing API Collection
                summary: null
                description: ''
                href: https://api.getpostman.com/collections/12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
                parentFolderId: 1
            Update Folder:
              value:
                id: 1
                parentFolderId: 0
                updatedAt: '2022-12-07T20:27:06.000Z'
                updatedBy: 12345678
                createdBy: 12345678
                createdAt: '2022-12-07T17:04:23.000Z'
                name: Billing
                description: The Billing API.
                type: folder
    common500ErrorServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: serverError
                  message:
                    type: string
                    description: The error message.
                    example: An error has occurred on the server.
          example:
            error:
              name: serverError
              message: An error has occurred on the server.
    getAllPanAddElementRequests:
      description: Successful Response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/getAllPanAddElementRequests'
          example:
            requests:
            - id: 1
              createdBy: 87654321
              createdAt: '2020-06-01T08:32:31.000Z'
              status: pending
              element:
                type: api
                id: 360b75f-447e-467c-9299-12fd3c92450d
                name: Test api
                summary: Test api summary
            - id: 2
              createdBy: 12345678
              createdAt: '2022-06-09T14:48:45.000Z'
              message: Please approve this collection
              status: denied
              element:
                type: collection
                id: 5360b75f-447e-467c-9299-12fd3c92450d
                name: Test Collection
                summary: This is a test collection.
              response:
                createdAt: '2020-06-01T08:32:31.000Z'
                createdBy: 2272
                message: Too many errors, please fix and resubmit
            meta:
              limit: 10
              offset: 5
              totalCount: 100
    postPanElementOrFolder:
      description: Created
      content:
        application/json:
          schema:
            oneOf:
            - $ref: '#/components/schemas/panElementCreated'
            - $ref: '#/components/schemas/panFolderCreated'
          examples:
            Add a Collection:
              value:
                addedAt: '2022-12-07T18:22:15.000Z'
                addedBy: 12345678
                createdBy: 12345678
                createdAt: '2022-12-07T18:22:15.000Z'
                updatedBy: 12345678
                updatedAt: '2022-12-07T18:22:15.000Z'
                type: collection
                id: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
                name: Billing API Collection
                summary: The Billing API collection.
                description: ''
                href: https://api.getpostman.com/collections/12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
            Create a Folder:
              value:
                id: 1
                parentFolderId: 0
                updatedAt: '2022-12-07T18:00:39.000Z'
                updatedBy: 12345678
                createdBy: 12345678
                createdAt: '2022-12-07T18:00:39.000Z'
                name: Billing
                description: The Billing API.
                type: folder
    getPanElementsAndFolders:
      description: Successful Response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/getPanElementsAndFolders'
          example:
            elements:
            - addedAt: '2021-11-29T06:31:24.000Z'
              addedBy: 12345678
              createdBy: 12345678
              createdAt: '2020-06-01T08:32:31.000Z'
              updatedBy: 12345678
              updatedAt: '2021-11-29T06:31:24.000Z'
              type: api
              id: 5360b75f-447e-467c-9299-12fd6c92450d
              parentFolderId: 1
              name: Billing API
              summary: Payments and Account Services API
              description: The payments and account services API.
              href: https://api.getpostman.com/apis/5360b75f-447e-467c-9299-12fd6c92450d
            - addedAt: '2021-11-29T06:31:26.000Z'
              addedBy: 12345678
              createdBy: 12345678
              createdAt: '2020-06-01T13:59:34.000Z'
              updatedBy: 12345678
              updatedAt: '2021-11-29T06:31:26.000Z'
              type: api
              id: 41f6dc6d-d8ab-45c6-8506-74a25acf5d5f
              parentFolderId: 2
              name: Reporting API
              summary: The reporting API.
              description: ''
              href: https://api.getpostman.com/apis/41f6dc6d-d8ab-45c6-8506-74a25acf5d5f
            folders:
            - id: 1
              parentFolderId: 0
              updatedAt: '2021-11-29T06:31:24.000Z'
              updatedBy: 12345678
              createdBy: 12345678
              createdAt: '2020-06-01T08:32:31.000Z'
              name: Billing
              description: The Billing API.
              type: folder
            - id: 2
              parentFolderId: 0
              updatedAt: '2022-10-17T11:54:51.000Z'
              updatedBy: 12345678
              createdBy: 12345678
              createdAt: '2021-03-05T06:27:24.000Z'
              name: Reporting
              description: ''
              type: folder
            meta:
              limit: 1000
              offset: 0
              totalCount: 2
    pan400ErrorInvalidQueryParams:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/pan400ErrorInvalidQueryParams'
          example:
            name: invalidParamsError
            message: The specified request does not exist.
    common403Error:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/common403Error'
          example:
            value:
              type: https://api.postman.com/problems/forbidden
              title: Forbidden
              detail: Forbidden
              status: 403
    deletePanElementOrFolder:
      description: Successful Response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/deletePanElementOrFolder'
          examples:
            Remove an API:
              value:
                api:
                  id: 5360b75f-447e-467c-9299-12fd6c92450d
            Delete a Folder:
              value:
                folder:
                  id: '1'
  schemas:
    untilDateTime:
      type: string
      format: date-time
      example: '2022-06-15T00:00:00.000Z'
    getPanElementsAndFolders:
      title: Successful Response
      type: object
      properties:
        elements:
          description: Information about a Private API Network's folder elements. Elements are APIs, collections, and workspaces.
          type: array
          items:
            type: object
            properties:
              createdAt:
                type: string
                format: date-time
                description: The date and time at which the element was created.
                example: '2020-06-01T08:32:31.000Z'
              createdBy:
                type: integer
                description: The user who created the element.
                example: 12345678
              updatedAt:
                type: string
                format: date-time
                description: The date and time at which the element was last updated.
                example: '2021-11-29T06:31:24.000Z'
              updatedBy:
                type: integer
                description: The user who updated the element.
                example: 12345678
              addedAt:
                type: string
                format: date-time
                description: The date and time at which the element was published to Private API Network. This value is the same as the `updatedAt` value.
                example: '2021-11-29T06:31:24.000Z'
              addedBy:
                type: integer
                description: The user ID of the user who published the element.
                example: 12345678
              description:
                type: string
                description: The element's description.
                example: The payments and account services API.
              id:
                type: string
                description: The element's ID.
                example: 5360b75f-447e-467c-9299-12fd6c92450d
              name:
                type: string
                description: The element's name.
                example: Billing API
              summary:
                type: string
                description: The element's summary.
                example: Payments and Account Services API
              type:
                type: string
                description: The element's type.
                example: api
              parentFolderId:
                type: integer
                description: The element's parent folder ID.
                example: 1
              href:
                type: string
                format: url
                description: The element's HREF.
                example: https://api.getpostman.com/apis/5360b75f-447e-467c-9299-12fd6c92450d
        folders:
          type: array
          description: Information about the Private API Network's folders.
          items:
            type: object
            properties:
              id:
                type: integer
                description: The folder's ID.
                example: 1
              parentFolderId:
                type: integer
                description: The folder's parent folder ID.
                example: 0
              updatedAt:
                type: string
                format: date-time
                description: The date and time at which the folder was updated.
                example: '2021-11-29T06:31:24.000Z'
              updatedBy:
                type: integer
                description: The user ID of the user who updated the folder.
                example: 12345678
              createdAt:
                type: string
                format: date-time
                description: The date and time at which the folder was created.
                example: '2020-06-01T08:32:31.000Z'
              createdBy:
                type: integer
                description: The user who created the folder.
                example: 12345678
              name:
                type: string
                description: The folder's name.
                example: Billing
              description:
                type: string
                description: The folder's description.
                example: The Billing API.
              type:
                type: string
                description: The element's type. This value is always `folder`.
                example: folder
        meta:
          type: object
          description: The response's non-standard meta information.
          properties:
            limit:
              type: integer
              description: The maximum number of elements returned. If the value exceeds the maximum value of `1000`, then the system uses the `1000` value.
              example: 1000
            offset:
              type: integer
              example: 0
              description: The zero-based offset of the first item returned.
            totalCount:
              type: integer
              example: 2
              description: The total count of the `elements` and `folders` items.
    panCreateCollection:
      title: Add Collection
      type: object
      properties:
        collection:
          type: object
          required:
          - id
          - parentFolderId
          properties:
            id:
              type: string
              description: The collection's ID.
              example: 5360b75f-447e-467c-9299-12fd6c92450d
            parentFolderId:
              type: integer
              description: The collection's parent folder ID.
              example: 1
            environments:
              type: array
              description: A list of environment UIDs (`userId`-`environmentId``) to add to the collection.
              items:
                type: string
                format: uid
                description: An environment's UID.
                example: 12345678-622c084d-4f48-470b-826e-18af3c65c775
    panCreateApi:
      title: Add API
      type: object
      properties:
        api:
          type: object
          required:
          - id
          - parentFolderId
          properties:
            id:
              type: string
              description: The API's ID.
              example: 5360b75f-447e-467c-9299-12fd6c92450d
            parentFolderId:
              type: integer
              description: The API's parent folder ID.
              example: 1
    panElementCreated:
      title: Element Created
      description: Information about the Private API Network element.
      type: object
      properties:
        addedAt:
          type: string
          format: date-time
          description: The date and time at which the element was added.
          example: '2022-06-09T14:48:45.000Z'
        addedBy:
          type: integer
          description: The user who added the element.
          example: 12345678
        createdBy:
          type: integer
          description: The user who created the element.
          example: 12345678
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the element was created.
          example: '2021-10-11T09:39:33.000Z'
        updatedBy:
          type: integer
          description: The user who last updated the element.
          example: 12345678
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the element was last updated.
          example: '2022-12-07T17:54:33.000Z'
        type:
          type: string
     

# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/engineering-platform/refs/heads/main/openapi/engineering-platform-private-api-network-api-openapi.yml